├── .dockerignore ├── .formatter.exs ├── .gitignore ├── .tool-versions ├── CHANGELOG ├── Dockerfile ├── LICENSE ├── README.md ├── bin ├── release_linux └── release_macos ├── config ├── config.exs ├── dev.exs └── prod.exs ├── lib ├── tefter.ex ├── tefter │ ├── base_url_middleware.ex │ └── tesla_authentication_middleware.ex ├── tefter_cli.ex └── tefter_cli │ ├── aliases.ex │ ├── app.ex │ ├── app │ └── state.ex │ ├── application.ex │ ├── auth_server.ex │ ├── authentication.ex │ ├── bookmarks.ex │ ├── cache.ex │ ├── command.ex │ ├── config.ex │ ├── system.ex │ └── views │ ├── aliases.ex │ ├── aliases │ ├── actions.ex │ └── state.ex │ ├── authentication.ex │ ├── bookmarks.ex │ ├── bookmarks │ ├── actions.ex │ └── state.ex │ ├── components │ ├── bottom_bar.ex │ ├── cursor.ex │ ├── info_panel.ex │ ├── pagination.ex │ └── top_bar.ex │ ├── help.ex │ ├── helpers │ └── text.ex │ ├── lists.ex │ ├── search.ex │ └── search │ └── state.ex ├── log └── .keep ├── mix.exs ├── mix.lock └── test ├── tefter_cli_test.exs └── test_helper.exs /.dockerignore: -------------------------------------------------------------------------------- 1 | .git/ 2 | _build/ 3 | deps/ 4 | tmp/ 5 | log/ 6 | releases/ 7 | -------------------------------------------------------------------------------- /.formatter.exs: -------------------------------------------------------------------------------- 1 | # Used by "mix format" 2 | [ 3 | inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"] 4 | ] 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # The directory Mix will write compiled artifacts to. 2 | /_build/ 3 | 4 | # If you run "mix test --cover", coverage assets end up here. 5 | /cover/ 6 | 7 | # The directory Mix downloads your dependencies sources to. 8 | /deps/ 9 | 10 | # Where 3rd-party dependencies like ExDoc output generated docs. 11 | /doc/ 12 | 13 | # Ignore .fetch files in case you like to edit your project deps locally. 14 | /.fetch 15 | 16 | # If the VM crashes, it generates a dump, let's ignore it too. 17 | erl_crash.dump 18 | 19 | # Also ignore archive artifacts (built via "mix archive.build"). 20 | *.ez 21 | 22 | # Release archives 23 | /releases/ 24 | 25 | /log/ 26 | # Since we are building assets from assets/, 27 | # we ignore priv/static. You may want to comment 28 | # this depending on your deployment strategy. 29 | /priv/static/ 30 | 31 | # Local config file 32 | .env 33 | 34 | -------------------------------------------------------------------------------- /.tool-versions: -------------------------------------------------------------------------------- 1 | erlang 21.3.2 2 | elixir 1.9 3 | -------------------------------------------------------------------------------- /CHANGELOG: -------------------------------------------------------------------------------- 1 | # Change Log 2 | All notable changes to this project will be documented in this file. 3 | This project adheres to [Semantic Versioning](http://semver.org/). 4 | 5 | ## Unreleased 6 | 7 | ## [0.2.0] - 2020-03-13 8 | 9 | ### Added 10 | 11 | * Caching to aliases so that they now work offline 12 | * New `:go ` command which opens a browser window to the given alias 13 | * Scrolling in the help tab 14 | * Documentation for more shortcuts in help 15 | 16 | ## [0.1.2] - 2020-03-12 17 | 18 | ### Added 19 | 20 | * Aliases and bookmark views allow scrolling with `ctrl + d` and `ctrl + u` 21 | 22 | ## [0.1.1] - 2020-03-12 23 | 24 | ### Added 25 | 26 | * `home` button switches to the first tab 27 | * Opening a browser window to edit an alias with the `:e` command 28 | * Support for switching between tabs using the `tab` key 29 | 30 | ## [0.1.0] - 2020-03-07 31 | 32 | ### Added 33 | 34 | * Initial release 35 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM elixir:1.9-slim as builder 2 | 3 | RUN apt-get -qq update 4 | RUN apt-get -qq install git build-essential python 5 | 6 | WORKDIR /app 7 | 8 | RUN mix local.hex --force && \ 9 | mix local.rebar --force && \ 10 | mix hex.info 11 | 12 | ENV MIX_ENV prod 13 | 14 | ADD . . 15 | RUN mix deps.get 16 | RUN mix release --quiet --overwrite 17 | 18 | FROM debian:buster-slim 19 | 20 | RUN apt-get -qq update 21 | RUN apt-get -qq install locales libssl1.1 libtinfo5 xdg-utils 22 | 23 | WORKDIR /app 24 | COPY --from=builder /app/_build/prod/rel/tefter_cli . 25 | 26 | CMD ["./bin/tefter_cli", "start"] 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2020 Tefter 2 | 3 | GNU GENERAL PUBLIC LICENSE 4 | Version 3, 29 June 2007 5 | 6 | Copyright (C) 2007 Free Software Foundation, Inc. 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for 13 | software and other kinds of works. 14 | 15 | The licenses for most software and other practical works are designed 16 | to take away your freedom to share and change the works. By contrast, 17 | the GNU General Public License is intended to guarantee your freedom to 18 | share and change all versions of a program--to make sure it remains free 19 | software for all its users. We, the Free Software Foundation, use the 20 | GNU General Public License for most of our software; it applies also to 21 | any other work released this way by its authors. You can apply it to 22 | your programs, too. 23 | 24 | When we speak of free software, we are referring to freedom, not 25 | price. Our General Public Licenses are designed to make sure that you 26 | have the freedom to distribute copies of free software (and charge for 27 | them if you wish), that you receive source code or can get it if you 28 | want it, that you can change the software or use pieces of it in new 29 | free programs, and that you know you can do these things. 30 | 31 | To protect your rights, we need to prevent others from denying you 32 | these rights or asking you to surrender the rights. Therefore, you have 33 | certain responsibilities if you distribute copies of the software, or if 34 | you modify it: responsibilities to respect the freedom of others. 35 | 36 | For example, if you distribute copies of such a program, whether 37 | gratis or for a fee, you must pass on to the recipients the same 38 | freedoms that you received. You must make sure that they, too, receive 39 | or can get the source code. And you must show them these terms so they 40 | know their rights. 41 | 42 | Developers that use the GNU GPL protect your rights with two steps: 43 | (1) assert copyright on the software, and (2) offer you this License 44 | giving you legal permission to copy, distribute and/or modify it. 45 | 46 | For the developers' and authors' protection, the GPL clearly explains 47 | that there is no warranty for this free software. For both users' and 48 | authors' sake, the GPL requires that modified versions be marked as 49 | changed, so that their problems will not be attributed erroneously to 50 | authors of previous versions. 51 | 52 | Some devices are designed to deny users access to install or run 53 | modified versions of the software inside them, although the manufacturer 54 | can do so. This is fundamentally incompatible with the aim of 55 | protecting users' freedom to change the software. The systematic 56 | pattern of such abuse occurs in the area of products for individuals to 57 | use, which is precisely where it is most unacceptable. Therefore, we 58 | have designed this version of the GPL to prohibit the practice for those 59 | products. If such problems arise substantially in other domains, we 60 | stand ready to extend this provision to those domains in future versions 61 | of the GPL, as needed to protect the freedom of users. 62 | 63 | Finally, every program is threatened constantly by software patents. 64 | States should not allow patents to restrict development and use of 65 | software on general-purpose computers, but in those that do, we wish to 66 | avoid the special danger that patents applied to a free program could 67 | make it effectively proprietary. To prevent this, the GPL assures that 68 | patents cannot be used to render the program non-free. 69 | 70 | The precise terms and conditions for copying, distribution and 71 | modification follow. 72 | 73 | TERMS AND CONDITIONS 74 | 75 | 0. Definitions. 76 | 77 | "This License" refers to version 3 of the GNU General Public License. 78 | 79 | "Copyright" also means copyright-like laws that apply to other kinds of 80 | works, such as semiconductor masks. 81 | 82 | "The Program" refers to any copyrightable work licensed under this 83 | License. Each licensee is addressed as "you". "Licensees" and 84 | "recipients" may be individuals or organizations. 85 | 86 | To "modify" a work means to copy from or adapt all or part of the work 87 | in a fashion requiring copyright permission, other than the making of an 88 | exact copy. The resulting work is called a "modified version" of the 89 | earlier work or a work "based on" the earlier work. 90 | 91 | A "covered work" means either the unmodified Program or a work based 92 | on the Program. 93 | 94 | To "propagate" a work means to do anything with it that, without 95 | permission, would make you directly or secondarily liable for 96 | infringement under applicable copyright law, except executing it on a 97 | computer or modifying a private copy. Propagation includes copying, 98 | distribution (with or without modification), making available to the 99 | public, and in some countries other activities as well. 100 | 101 | To "convey" a work means any kind of propagation that enables other 102 | parties to make or receive copies. Mere interaction with a user through 103 | a computer network, with no transfer of a copy, is not conveying. 104 | 105 | An interactive user interface displays "Appropriate Legal Notices" 106 | to the extent that it includes a convenient and prominently visible 107 | feature that (1) displays an appropriate copyright notice, and (2) 108 | tells the user that there is no warranty for the work (except to the 109 | extent that warranties are provided), that licensees may convey the 110 | work under this License, and how to view a copy of this License. If 111 | the interface presents a list of user commands or options, such as a 112 | menu, a prominent item in the list meets this criterion. 113 | 114 | 1. Source Code. 115 | 116 | The "source code" for a work means the preferred form of the work 117 | for making modifications to it. "Object code" means any non-source 118 | form of a work. 119 | 120 | A "Standard Interface" means an interface that either is an official 121 | standard defined by a recognized standards body, or, in the case of 122 | interfaces specified for a particular programming language, one that 123 | is widely used among developers working in that language. 124 | 125 | The "System Libraries" of an executable work include anything, other 126 | than the work as a whole, that (a) is included in the normal form of 127 | packaging a Major Component, but which is not part of that Major 128 | Component, and (b) serves only to enable use of the work with that 129 | Major Component, or to implement a Standard Interface for which an 130 | implementation is available to the public in source code form. A 131 | "Major Component", in this context, means a major essential component 132 | (kernel, window system, and so on) of the specific operating system 133 | (if any) on which the executable work runs, or a compiler used to 134 | produce the work, or an object code interpreter used to run it. 135 | 136 | The "Corresponding Source" for a work in object code form means all 137 | the source code needed to generate, install, and (for an executable 138 | work) run the object code and to modify the work, including scripts to 139 | control those activities. However, it does not include the work's 140 | System Libraries, or general-purpose tools or generally available free 141 | programs which are used unmodified in performing those activities but 142 | which are not part of the work. For example, Corresponding Source 143 | includes interface definition files associated with source files for 144 | the work, and the source code for shared libraries and dynamically 145 | linked subprograms that the work is specifically designed to require, 146 | such as by intimate data communication or control flow between those 147 | subprograms and other parts of the work. 148 | 149 | The Corresponding Source need not include anything that users 150 | can regenerate automatically from other parts of the Corresponding 151 | Source. 152 | 153 | The Corresponding Source for a work in source code form is that 154 | same work. 155 | 156 | 2. Basic Permissions. 157 | 158 | All rights granted under this License are granted for the term of 159 | copyright on the Program, and are irrevocable provided the stated 160 | conditions are met. This License explicitly affirms your unlimited 161 | permission to run the unmodified Program. The output from running a 162 | covered work is covered by this License only if the output, given its 163 | content, constitutes a covered work. This License acknowledges your 164 | rights of fair use or other equivalent, as provided by copyright law. 165 | 166 | You may make, run and propagate covered works that you do not 167 | convey, without conditions so long as your license otherwise remains 168 | in force. You may convey covered works to others for the sole purpose 169 | of having them make modifications exclusively for you, or provide you 170 | with facilities for running those works, provided that you comply with 171 | the terms of this License in conveying all material for which you do 172 | not control copyright. Those thus making or running the covered works 173 | for you must do so exclusively on your behalf, under your direction 174 | and control, on terms that prohibit them from making any copies of 175 | your copyrighted material outside their relationship with you. 176 | 177 | Conveying under any other circumstances is permitted solely under 178 | the conditions stated below. Sublicensing is not allowed; section 10 179 | makes it unnecessary. 180 | 181 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 182 | 183 | No covered work shall be deemed part of an effective technological 184 | measure under any applicable law fulfilling obligations under article 185 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 186 | similar laws prohibiting or restricting circumvention of such 187 | measures. 188 | 189 | When you convey a covered work, you waive any legal power to forbid 190 | circumvention of technological measures to the extent such circumvention 191 | is effected by exercising rights under this License with respect to 192 | the covered work, and you disclaim any intention to limit operation or 193 | modification of the work as a means of enforcing, against the work's 194 | users, your or third parties' legal rights to forbid circumvention of 195 | technological measures. 196 | 197 | 4. Conveying Verbatim Copies. 198 | 199 | You may convey verbatim copies of the Program's source code as you 200 | receive it, in any medium, provided that you conspicuously and 201 | appropriately publish on each copy an appropriate copyright notice; 202 | keep intact all notices stating that this License and any 203 | non-permissive terms added in accord with section 7 apply to the code; 204 | keep intact all notices of the absence of any warranty; and give all 205 | recipients a copy of this License along with the Program. 206 | 207 | You may charge any price or no price for each copy that you convey, 208 | and you may offer support or warranty protection for a fee. 209 | 210 | 5. Conveying Modified Source Versions. 211 | 212 | You may convey a work based on the Program, or the modifications to 213 | produce it from the Program, in the form of source code under the 214 | terms of section 4, provided that you also meet all of these conditions: 215 | 216 | a) The work must carry prominent notices stating that you modified 217 | it, and giving a relevant date. 218 | 219 | b) The work must carry prominent notices stating that it is 220 | released under this License and any conditions added under section 221 | 7. This requirement modifies the requirement in section 4 to 222 | "keep intact all notices". 223 | 224 | c) You must license the entire work, as a whole, under this 225 | License to anyone who comes into possession of a copy. This 226 | License will therefore apply, along with any applicable section 7 227 | additional terms, to the whole of the work, and all its parts, 228 | regardless of how they are packaged. This License gives no 229 | permission to license the work in any other way, but it does not 230 | invalidate such permission if you have separately received it. 231 | 232 | d) If the work has interactive user interfaces, each must display 233 | Appropriate Legal Notices; however, if the Program has interactive 234 | interfaces that do not display Appropriate Legal Notices, your 235 | work need not make them do so. 236 | 237 | A compilation of a covered work with other separate and independent 238 | works, which are not by their nature extensions of the covered work, 239 | and which are not combined with it such as to form a larger program, 240 | in or on a volume of a storage or distribution medium, is called an 241 | "aggregate" if the compilation and its resulting copyright are not 242 | used to limit the access or legal rights of the compilation's users 243 | beyond what the individual works permit. Inclusion of a covered work 244 | in an aggregate does not cause this License to apply to the other 245 | parts of the aggregate. 246 | 247 | 6. Conveying Non-Source Forms. 248 | 249 | You may convey a covered work in object code form under the terms 250 | of sections 4 and 5, provided that you also convey the 251 | machine-readable Corresponding Source under the terms of this License, 252 | in one of these ways: 253 | 254 | a) Convey the object code in, or embodied in, a physical product 255 | (including a physical distribution medium), accompanied by the 256 | Corresponding Source fixed on a durable physical medium 257 | customarily used for software interchange. 258 | 259 | b) Convey the object code in, or embodied in, a physical product 260 | (including a physical distribution medium), accompanied by a 261 | written offer, valid for at least three years and valid for as 262 | long as you offer spare parts or customer support for that product 263 | model, to give anyone who possesses the object code either (1) a 264 | copy of the Corresponding Source for all the software in the 265 | product that is covered by this License, on a durable physical 266 | medium customarily used for software interchange, for a price no 267 | more than your reasonable cost of physically performing this 268 | conveying of source, or (2) access to copy the 269 | Corresponding Source from a network server at no charge. 270 | 271 | c) Convey individual copies of the object code with a copy of the 272 | written offer to provide the Corresponding Source. This 273 | alternative is allowed only occasionally and noncommercially, and 274 | only if you received the object code with such an offer, in accord 275 | with subsection 6b. 276 | 277 | d) Convey the object code by offering access from a designated 278 | place (gratis or for a charge), and offer equivalent access to the 279 | Corresponding Source in the same way through the same place at no 280 | further charge. You need not require recipients to copy the 281 | Corresponding Source along with the object code. If the place to 282 | copy the object code is a network server, the Corresponding Source 283 | may be on a different server (operated by you or a third party) 284 | that supports equivalent copying facilities, provided you maintain 285 | clear directions next to the object code saying where to find the 286 | Corresponding Source. Regardless of what server hosts the 287 | Corresponding Source, you remain obligated to ensure that it is 288 | available for as long as needed to satisfy these requirements. 289 | 290 | e) Convey the object code using peer-to-peer transmission, provided 291 | you inform other peers where the object code and Corresponding 292 | Source of the work are being offered to the general public at no 293 | charge under subsection 6d. 294 | 295 | A separable portion of the object code, whose source code is excluded 296 | from the Corresponding Source as a System Library, need not be 297 | included in conveying the object code work. 298 | 299 | A "User Product" is either (1) a "consumer product", which means any 300 | tangible personal property which is normally used for personal, family, 301 | or household purposes, or (2) anything designed or sold for incorporation 302 | into a dwelling. In determining whether a product is a consumer product, 303 | doubtful cases shall be resolved in favor of coverage. For a particular 304 | product received by a particular user, "normally used" refers to a 305 | typical or common use of that class of product, regardless of the status 306 | of the particular user or of the way in which the particular user 307 | actually uses, or expects or is expected to use, the product. A product 308 | is a consumer product regardless of whether the product has substantial 309 | commercial, industrial or non-consumer uses, unless such uses represent 310 | the only significant mode of use of the product. 311 | 312 | "Installation Information" for a User Product means any methods, 313 | procedures, authorization keys, or other information required to install 314 | and execute modified versions of a covered work in that User Product from 315 | a modified version of its Corresponding Source. The information must 316 | suffice to ensure that the continued functioning of the modified object 317 | code is in no case prevented or interfered with solely because 318 | modification has been made. 319 | 320 | If you convey an object code work under this section in, or with, or 321 | specifically for use in, a User Product, and the conveying occurs as 322 | part of a transaction in which the right of possession and use of the 323 | User Product is transferred to the recipient in perpetuity or for a 324 | fixed term (regardless of how the transaction is characterized), the 325 | Corresponding Source conveyed under this section must be accompanied 326 | by the Installation Information. But this requirement does not apply 327 | if neither you nor any third party retains the ability to install 328 | modified object code on the User Product (for example, the work has 329 | been installed in ROM). 330 | 331 | The requirement to provide Installation Information does not include a 332 | requirement to continue to provide support service, warranty, or updates 333 | for a work that has been modified or installed by the recipient, or for 334 | the User Product in which it has been modified or installed. Access to a 335 | network may be denied when the modification itself materially and 336 | adversely affects the operation of the network or violates the rules and 337 | protocols for communication across the network. 338 | 339 | Corresponding Source conveyed, and Installation Information provided, 340 | in accord with this section must be in a format that is publicly 341 | documented (and with an implementation available to the public in 342 | source code form), and must require no special password or key for 343 | unpacking, reading or copying. 344 | 345 | 7. Additional Terms. 346 | 347 | "Additional permissions" are terms that supplement the terms of this 348 | License by making exceptions from one or more of its conditions. 349 | Additional permissions that are applicable to the entire Program shall 350 | be treated as though they were included in this License, to the extent 351 | that they are valid under applicable law. If additional permissions 352 | apply only to part of the Program, that part may be used separately 353 | under those permissions, but the entire Program remains governed by 354 | this License without regard to the additional permissions. 355 | 356 | When you convey a copy of a covered work, you may at your option 357 | remove any additional permissions from that copy, or from any part of 358 | it. (Additional permissions may be written to require their own 359 | removal in certain cases when you modify the work.) You may place 360 | additional permissions on material, added by you to a covered work, 361 | for which you have or can give appropriate copyright permission. 362 | 363 | Notwithstanding any other provision of this License, for material you 364 | add to a covered work, you may (if authorized by the copyright holders of 365 | that material) supplement the terms of this License with terms: 366 | 367 | a) Disclaiming warranty or limiting liability differently from the 368 | terms of sections 15 and 16 of this License; or 369 | 370 | b) Requiring preservation of specified reasonable legal notices or 371 | author attributions in that material or in the Appropriate Legal 372 | Notices displayed by works containing it; or 373 | 374 | c) Prohibiting misrepresentation of the origin of that material, or 375 | requiring that modified versions of such material be marked in 376 | reasonable ways as different from the original version; or 377 | 378 | d) Limiting the use for publicity purposes of names of licensors or 379 | authors of the material; or 380 | 381 | e) Declining to grant rights under trademark law for use of some 382 | trade names, trademarks, or service marks; or 383 | 384 | f) Requiring indemnification of licensors and authors of that 385 | material by anyone who conveys the material (or modified versions of 386 | it) with contractual assumptions of liability to the recipient, for 387 | any liability that these contractual assumptions directly impose on 388 | those licensors and authors. 389 | 390 | All other non-permissive additional terms are considered "further 391 | restrictions" within the meaning of section 10. If the Program as you 392 | received it, or any part of it, contains a notice stating that it is 393 | governed by this License along with a term that is a further 394 | restriction, you may remove that term. If a license document contains 395 | a further restriction but permits relicensing or conveying under this 396 | License, you may add to a covered work material governed by the terms 397 | of that license document, provided that the further restriction does 398 | not survive such relicensing or conveying. 399 | 400 | If you add terms to a covered work in accord with this section, you 401 | must place, in the relevant source files, a statement of the 402 | additional terms that apply to those files, or a notice indicating 403 | where to find the applicable terms. 404 | 405 | Additional terms, permissive or non-permissive, may be stated in the 406 | form of a separately written license, or stated as exceptions; 407 | the above requirements apply either way. 408 | 409 | 8. Termination. 410 | 411 | You may not propagate or modify a covered work except as expressly 412 | provided under this License. Any attempt otherwise to propagate or 413 | modify it is void, and will automatically terminate your rights under 414 | this License (including any patent licenses granted under the third 415 | paragraph of section 11). 416 | 417 | However, if you cease all violation of this License, then your 418 | license from a particular copyright holder is reinstated (a) 419 | provisionally, unless and until the copyright holder explicitly and 420 | finally terminates your license, and (b) permanently, if the copyright 421 | holder fails to notify you of the violation by some reasonable means 422 | prior to 60 days after the cessation. 423 | 424 | Moreover, your license from a particular copyright holder is 425 | reinstated permanently if the copyright holder notifies you of the 426 | violation by some reasonable means, this is the first time you have 427 | received notice of violation of this License (for any work) from that 428 | copyright holder, and you cure the violation prior to 30 days after 429 | your receipt of the notice. 430 | 431 | Termination of your rights under this section does not terminate the 432 | licenses of parties who have received copies or rights from you under 433 | this License. If your rights have been terminated and not permanently 434 | reinstated, you do not qualify to receive new licenses for the same 435 | material under section 10. 436 | 437 | 9. Acceptance Not Required for Having Copies. 438 | 439 | You are not required to accept this License in order to receive or 440 | run a copy of the Program. Ancillary propagation of a covered work 441 | occurring solely as a consequence of using peer-to-peer transmission 442 | to receive a copy likewise does not require acceptance. However, 443 | nothing other than this License grants you permission to propagate or 444 | modify any covered work. These actions infringe copyright if you do 445 | not accept this License. Therefore, by modifying or propagating a 446 | covered work, you indicate your acceptance of this License to do so. 447 | 448 | 10. Automatic Licensing of Downstream Recipients. 449 | 450 | Each time you convey a covered work, the recipient automatically 451 | receives a license from the original licensors, to run, modify and 452 | propagate that work, subject to this License. You are not responsible 453 | for enforcing compliance by third parties with this License. 454 | 455 | An "entity transaction" is a transaction transferring control of an 456 | organization, or substantially all assets of one, or subdividing an 457 | organization, or merging organizations. If propagation of a covered 458 | work results from an entity transaction, each party to that 459 | transaction who receives a copy of the work also receives whatever 460 | licenses to the work the party's predecessor in interest had or could 461 | give under the previous paragraph, plus a right to possession of the 462 | Corresponding Source of the work from the predecessor in interest, if 463 | the predecessor has it or can get it with reasonable efforts. 464 | 465 | You may not impose any further restrictions on the exercise of the 466 | rights granted or affirmed under this License. For example, you may 467 | not impose a license fee, royalty, or other charge for exercise of 468 | rights granted under this License, and you may not initiate litigation 469 | (including a cross-claim or counterclaim in a lawsuit) alleging that 470 | any patent claim is infringed by making, using, selling, offering for 471 | sale, or importing the Program or any portion of it. 472 | 473 | 11. Patents. 474 | 475 | A "contributor" is a copyright holder who authorizes use under this 476 | License of the Program or a work on which the Program is based. The 477 | work thus licensed is called the contributor's "contributor version". 478 | 479 | A contributor's "essential patent claims" are all patent claims 480 | owned or controlled by the contributor, whether already acquired or 481 | hereafter acquired, that would be infringed by some manner, permitted 482 | by this License, of making, using, or selling its contributor version, 483 | but do not include claims that would be infringed only as a 484 | consequence of further modification of the contributor version. For 485 | purposes of this definition, "control" includes the right to grant 486 | patent sublicenses in a manner consistent with the requirements of 487 | this License. 488 | 489 | Each contributor grants you a non-exclusive, worldwide, royalty-free 490 | patent license under the contributor's essential patent claims, to 491 | make, use, sell, offer for sale, import and otherwise run, modify and 492 | propagate the contents of its contributor version. 493 | 494 | In the following three paragraphs, a "patent license" is any express 495 | agreement or commitment, however denominated, not to enforce a patent 496 | (such as an express permission to practice a patent or covenant not to 497 | sue for patent infringement). To "grant" such a patent license to a 498 | party means to make such an agreement or commitment not to enforce a 499 | patent against the party. 500 | 501 | If you convey a covered work, knowingly relying on a patent license, 502 | and the Corresponding Source of the work is not available for anyone 503 | to copy, free of charge and under the terms of this License, through a 504 | publicly available network server or other readily accessible means, 505 | then you must either (1) cause the Corresponding Source to be so 506 | available, or (2) arrange to deprive yourself of the benefit of the 507 | patent license for this particular work, or (3) arrange, in a manner 508 | consistent with the requirements of this License, to extend the patent 509 | license to downstream recipients. "Knowingly relying" means you have 510 | actual knowledge that, but for the patent license, your conveying the 511 | covered work in a country, or your recipient's use of the covered work 512 | in a country, would infringe one or more identifiable patents in that 513 | country that you have reason to believe are valid. 514 | 515 | If, pursuant to or in connection with a single transaction or 516 | arrangement, you convey, or propagate by procuring conveyance of, a 517 | covered work, and grant a patent license to some of the parties 518 | receiving the covered work authorizing them to use, propagate, modify 519 | or convey a specific copy of the covered work, then the patent license 520 | you grant is automatically extended to all recipients of the covered 521 | work and works based on it. 522 | 523 | A patent license is "discriminatory" if it does not include within 524 | the scope of its coverage, prohibits the exercise of, or is 525 | conditioned on the non-exercise of one or more of the rights that are 526 | specifically granted under this License. You may not convey a covered 527 | work if you are a party to an arrangement with a third party that is 528 | in the business of distributing software, under which you make payment 529 | to the third party based on the extent of your activity of conveying 530 | the work, and under which the third party grants, to any of the 531 | parties who would receive the covered work from you, a discriminatory 532 | patent license (a) in connection with copies of the covered work 533 | conveyed by you (or copies made from those copies), or (b) primarily 534 | for and in connection with specific products or compilations that 535 | contain the covered work, unless you entered into that arrangement, 536 | or that patent license was granted, prior to 28 March 2007. 537 | 538 | Nothing in this License shall be construed as excluding or limiting 539 | any implied license or other defenses to infringement that may 540 | otherwise be available to you under applicable patent law. 541 | 542 | 12. No Surrender of Others' Freedom. 543 | 544 | If conditions are imposed on you (whether by court order, agreement or 545 | otherwise) that contradict the conditions of this License, they do not 546 | excuse you from the conditions of this License. If you cannot convey a 547 | covered work so as to satisfy simultaneously your obligations under this 548 | License and any other pertinent obligations, then as a consequence you may 549 | not convey it at all. For example, if you agree to terms that obligate you 550 | to collect a royalty for further conveying from those to whom you convey 551 | the Program, the only way you could satisfy both those terms and this 552 | License would be to refrain entirely from conveying the Program. 553 | 554 | 13. Use with the GNU Affero General Public License. 555 | 556 | Notwithstanding any other provision of this License, you have 557 | permission to link or combine any covered work with a work licensed 558 | under version 3 of the GNU Affero General Public License into a single 559 | combined work, and to convey the resulting work. The terms of this 560 | License will continue to apply to the part which is the covered work, 561 | but the special requirements of the GNU Affero General Public License, 562 | section 13, concerning interaction through a network will apply to the 563 | combination as such. 564 | 565 | 14. Revised Versions of this License. 566 | 567 | The Free Software Foundation may publish revised and/or new versions of 568 | the GNU General Public License from time to time. Such new versions will 569 | be similar in spirit to the present version, but may differ in detail to 570 | address new problems or concerns. 571 | 572 | Each version is given a distinguishing version number. If the 573 | Program specifies that a certain numbered version of the GNU General 574 | Public License "or any later version" applies to it, you have the 575 | option of following the terms and conditions either of that numbered 576 | version or of any later version published by the Free Software 577 | Foundation. If the Program does not specify a version number of the 578 | GNU General Public License, you may choose any version ever published 579 | by the Free Software Foundation. 580 | 581 | If the Program specifies that a proxy can decide which future 582 | versions of the GNU General Public License can be used, that proxy's 583 | public statement of acceptance of a version permanently authorizes you 584 | to choose that version for the Program. 585 | 586 | Later license versions may give you additional or different 587 | permissions. However, no additional obligations are imposed on any 588 | author or copyright holder as a result of your choosing to follow a 589 | later version. 590 | 591 | 15. Disclaimer of Warranty. 592 | 593 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 594 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 595 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 596 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 597 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 598 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 599 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 600 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 601 | 602 | 16. Limitation of Liability. 603 | 604 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 605 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 606 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 607 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 608 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 609 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 610 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 611 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 612 | SUCH DAMAGES. 613 | 614 | 17. Interpretation of Sections 15 and 16. 615 | 616 | If the disclaimer of warranty and limitation of liability provided 617 | above cannot be given local legal effect according to their terms, 618 | reviewing courts shall apply local law that most closely approximates 619 | an absolute waiver of all civil liability in connection with the 620 | Program, unless a warranty or assumption of liability accompanies a 621 | copy of the Program in return for a fee. 622 | 623 | END OF TERMS AND CONDITIONS 624 | 625 | How to Apply These Terms to Your New Programs 626 | 627 | If you develop a new program, and you want it to be of the greatest 628 | possible use to the public, the best way to achieve this is to make it 629 | free software which everyone can redistribute and change under these terms. 630 | 631 | To do so, attach the following notices to the program. It is safest 632 | to attach them to the start of each source file to most effectively 633 | state the exclusion of warranty; and each file should have at least 634 | the "copyright" line and a pointer to where the full notice is found. 635 | 636 | 637 | Copyright (C) 638 | 639 | This program is free software: you can redistribute it and/or modify 640 | it under the terms of the GNU General Public License as published by 641 | the Free Software Foundation, either version 3 of the License, or 642 | (at your option) any later version. 643 | 644 | This program is distributed in the hope that it will be useful, 645 | but WITHOUT ANY WARRANTY; without even the implied warranty of 646 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 647 | GNU General Public License for more details. 648 | 649 | You should have received a copy of the GNU General Public License 650 | along with this program. If not, see . 651 | 652 | Also add information on how to contact you by electronic and paper mail. 653 | 654 | If the program does terminal interaction, make it output a short 655 | notice like this when it starts in an interactive mode: 656 | 657 | Copyright (C) 658 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 659 | This is free software, and you are welcome to redistribute it 660 | under certain conditions; type `show c' for details. 661 | 662 | The hypothetical commands `show w' and `show c' should show the appropriate 663 | parts of the General Public License. Of course, your program's commands 664 | might be different; for a GUI interface, you would use an "about box". 665 | 666 | You should also get your employer (if you work as a programmer) or school, 667 | if any, to sign a "copyright disclaimer" for the program, if necessary. 668 | For more information on this, and how to apply and follow the GNU GPL, see 669 | . 670 | 671 | The GNU General Public License does not permit incorporating your program 672 | into proprietary programs. If your program is a subroutine library, you 673 | may consider it more useful to permit linking proprietary applications with 674 | the library. If this is what you want to do, use the GNU Lesser General 675 | Public License instead of this License. But first, please read 676 | . 677 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![logo](https://i.imgur.com/58c5csa.png) 2 | 3 | The command-line client for [Tefter](https://tefter.io). 4 | 5 | # Installation 6 | 7 | Via brew: 8 | 9 | ```shell 10 | brew tap tefter/homebrew-cli 11 | brew install tefter 12 | ``` 13 | 14 | Alternatively download a compatible release for your system from [releases](https://github.com/tefter/cli/releases). 15 | 16 | Extract and run `tefter_cli`. 17 | 18 | The first time you run it, it'll try to open a browser window to authenticate your Tefter account. 19 | This method of of authentication works if you've already signed up via the browser and are logged in. 20 | A fallback auth mechanism is to create a `~/.tefter` file with your API token. 21 | 22 | ```json 23 | { 24 | "token": "your_token_here" 25 | } 26 | ``` 27 | 28 | You will find your token [here](https://tefter.io/users/edit). 29 | 30 | ## Features 31 | 32 | ### Search 33 | 34 | ![search](https://i.imgur.com/y6KtJ2g.png) 35 | 36 | Use `enter` to open a browser window with a result. 37 | 38 | ### Aliases 39 | 40 | ![aliases](https://i.imgur.com/LB6LbHP.png) 41 | 42 | **Commands** 43 | 44 | Create an alias. 45 | 46 | ``` 47 | :c 48 | ``` 49 | 50 | Delete an alias. 51 | 52 | ``` 53 | :d 54 | ``` 55 | 56 | ### Bookmarks 57 | 58 | ![bookmarks](https://i.imgur.com/kVvM4kN.png) 59 | 60 | **Filtering** 61 | 62 | ![filtering](https://i.imgur.com/LCWynDP.png) 63 | 64 | Use `/` to start filtering. 65 | 66 | **Commands** 67 | 68 | ![commands](https://i.imgur.com/6arscF3.png) 69 | 70 | Add a bookmark. 71 | 72 | ``` 73 | :c 74 | ``` 75 | 76 | Delete a bookmark. 77 | 78 | ``` 79 | :d 80 | ``` 81 | 82 | **Modals** 83 | 84 | Use the `:s` command to display more details about the bookmark under the cursor. 85 | 86 | ![modals](https://i.imgur.com/p5YIIza.png) 87 | 88 | ## Usage 89 | 90 | ![usage](https://i.imgur.com/dGbncJY.png) 91 | 92 | **Shortcuts** 93 | 94 | Key|Action 95 | ----|------| 96 | Ctrl+s|Jump to Search tab 97 | Ctrl+a|Jump to Aliases tab 98 | Ctrl+b|Jump to Bookmarks tab 99 | Ctrl+h|Jump to Help tab 100 | Tab|Jump to the next tab 101 | Home|Jump to the first tab 102 | ↑|Move up 103 | Ctrl+k|Move up 104 | ↓|Move down 105 | Ctrl+j|Move down 106 | Ctrl+d|Scroll down 107 | Ctrl+u|Scroll up 108 | Enter| Open browser window with item under cursor 109 | Esc|Cancel command / Quit modal 110 | F5|Force refresh resources| 111 | Ctrl+q|Quit 112 | /|Enter filtering mode 113 | :|Enter command mode 114 | 115 | ## Running Locally 116 | 117 | First, ensure you have the following versions of Elixir and OTP installed on your machine: 118 | 119 | ``` 120 | erlang 21.3.2 121 | elixir 1.9 122 | ``` 123 | 124 | Then, run: 125 | 126 | ```shell 127 | git clone git@github.com:tefter/cli.git 128 | mix deps.get 129 | mix run --no-halt 130 | ``` 131 | 132 | ## Releasing 133 | 134 | You can build portable [releases](https://hexdocs.pm/mix/Mix.Tasks.Release.html) per platform, 135 | which include the Erlang VM and don't require installing Erlang / Elixir on the target system. 136 | 137 | ### Linux 138 | 139 | Run: 140 | 141 | ```shell 142 | ./bin/release_linux 143 | ``` 144 | 145 | ### MacOS 146 | 147 | Run: 148 | 149 | ```shell 150 | ./bin/release_macos 151 | ``` 152 | 153 | ## License 154 | 155 | Copyright (c) 2020 Tefter, GPLv3 License. 156 | See [LICENSE.txt](https://github.com/tefter/cli/blob/master/LICENSE) for further details. 157 | -------------------------------------------------------------------------------- /bin/release_linux: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | docker build -t cli . 4 | docker cp $(docker create cli:latest):/app ./releases/tefter_linux_x86_64 5 | 6 | cat > ./releases/tefter_linux_x86_64/tefter <<- "EOF" 7 | ./bin/tefter_cli start 8 | EOF 9 | 10 | chmod u+x ./releases/tefter_linux_x86_64/tefter 11 | cd releases 12 | tar -zcf linux_x86_64.tar.gz ./tefter_linux_x86_64/ 13 | 14 | rm -rf ./tefter_linux_x86_64 15 | 16 | echo Done! 17 | -------------------------------------------------------------------------------- /bin/release_macos: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | os="$(uname -s)" 4 | 5 | test "$os" != 'Darwin' && (echo 'The MacOS release must be built on a MacOS system, sorry.'; exit 1) 6 | 7 | MIX_ENV=prod mix release --quiet --overwrite 8 | 9 | cat > _build/prod/rel/tefter_cli/tefter <<- "EOF" 10 | ./bin/tefter_cli start 11 | EOF 12 | 13 | chmod u+x _build/prod/rel/tefter_cli/tefter 14 | cd _build/prod/rel/tefter_cli 15 | zip -rq ./../../../../releases/macos.zip . 16 | 17 | echo Done! 18 | -------------------------------------------------------------------------------- /config/config.exs: -------------------------------------------------------------------------------- 1 | # This file is responsible for configuring your application 2 | # and its dependencies with the aid of the Mix.Config module. 3 | use Mix.Config 4 | 5 | # This configuration is loaded before any dependency and is restricted 6 | # to this project. If another project depends on this project, this 7 | # file won't be loaded nor affect the parent project. For this reason, 8 | # if you want to provide default values for your application for 9 | # third-party users, it should be done in your "mix.exs" file. 10 | 11 | # You can configure your application as: 12 | # 13 | # config :tefter_cli, key: :value 14 | # 15 | # and access this configuration in your application as: 16 | # 17 | # Application.get_env(:tefter_cli, :key) 18 | # 19 | # You can also configure a third-party app: 20 | # 21 | config :logger, 22 | backends: [ 23 | {LoggerFileBackend, :dev} 24 | ] 25 | 26 | config :logger, :dev, 27 | path: "log/dev.log", 28 | level: :debug 29 | 30 | config :porcelain, goon_warn_if_missing: false 31 | 32 | # It is also possible to import configuration files, relative to this 33 | # directory. For example, you can emulate configuration per environment 34 | # by uncommenting the line below and defining dev.exs, test.exs and such. 35 | # Configuration from the imported file will override the ones defined 36 | # here (which is why it is important to import them last). 37 | # 38 | import_config "#{Mix.env()}.exs" 39 | -------------------------------------------------------------------------------- /config/dev.exs: -------------------------------------------------------------------------------- 1 | use Mix.Config 2 | -------------------------------------------------------------------------------- /config/prod.exs: -------------------------------------------------------------------------------- 1 | use Mix.Config 2 | 3 | config :logger, backends: [] 4 | 5 | config :logger, :dev, 6 | path: "log/dev.log", 7 | level: :error 8 | -------------------------------------------------------------------------------- /lib/tefter.ex: -------------------------------------------------------------------------------- 1 | defmodule Tefter do 2 | @moduledoc """ 3 | API client for Tefter 4 | See: https://tefter.io/docs/api 5 | """ 6 | 7 | use Tesla 8 | 9 | alias TefterCli.Authentication 10 | 11 | plug(Tefter.BaseUrlMiddleware, &base_url/0) 12 | plug(Tesla.Middleware.Headers, [{"accept", "application/json"}]) 13 | plug(Tefter.TefterAuthenticationMiddleware, &Authentication.token/0) 14 | plug(Tesla.Middleware.JSON) 15 | 16 | def suggestions(%{query: prefix}) do 17 | get("/suggestions", query: %{prefix: prefix}) 18 | end 19 | 20 | def aliases do 21 | get("/aliases") 22 | end 23 | 24 | def create_bookmark(%{url: url}) do 25 | post("/api/bookmarks", %{url: url}) 26 | end 27 | 28 | def delete_bookmark(%{id: id}) do 29 | delete("/bookmarks/#{id}") 30 | end 31 | 32 | def bookmarks do 33 | get("/bookmarks") 34 | end 35 | 36 | def bookmarks_export do 37 | get("/export/bookmarks") 38 | end 39 | 40 | def create_alias(%{url: url, alias: alias}) do 41 | post("/aliases/create_from_extension", %{url: url, name: alias}) 42 | end 43 | 44 | def delete_alias(%{id: id}) do 45 | delete("/aliases/#{id}") 46 | end 47 | 48 | def base_url, do: "https://tefter.io" 49 | end 50 | -------------------------------------------------------------------------------- /lib/tefter/base_url_middleware.ex: -------------------------------------------------------------------------------- 1 | defmodule Tefter.BaseUrlMiddleware do 2 | def call(env, next, fun) do 3 | Tesla.Middleware.BaseUrl.call(env, next, fun.()) 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /lib/tefter/tesla_authentication_middleware.ex: -------------------------------------------------------------------------------- 1 | defmodule Tefter.TefterAuthenticationMiddleware do 2 | @auth_header "X-User-Token" 3 | 4 | def call(env, next, fun) do 5 | env 6 | |> Tesla.put_header(@auth_header, fun.()) 7 | |> Tesla.run(next) 8 | end 9 | end 10 | -------------------------------------------------------------------------------- /lib/tefter_cli.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli do 2 | @moduledoc """ 3 | Documentation for TefterCli. 4 | """ 5 | 6 | @version "0.2.0" 7 | 8 | def version, do: @version 9 | end 10 | -------------------------------------------------------------------------------- /lib/tefter_cli/aliases.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Aliases do 2 | alias TefterCli.Cache 3 | 4 | def fetch(%{force: true}), do: Cache.update(:aliases, do_fetch()) 5 | def fetch(_), do: Cache.fetch(:aliases, fn -> do_fetch() end) 6 | 7 | defp do_fetch do 8 | case Tefter.aliases() do 9 | {:ok, %{status: 200, body: %{"aliases" => aliases}}} -> aliases 10 | _ -> [] 11 | end 12 | end 13 | end 14 | -------------------------------------------------------------------------------- /lib/tefter_cli/app.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.App do 2 | @moduledoc """ 3 | The main module of the application. 4 | It delegates rendering and state updates to a module per tab. 5 | """ 6 | 7 | @behaviour Ratatouille.App 8 | 9 | alias Ratatouille.Runtime.{Subscription} 10 | alias TefterCli.App.State 11 | alias TefterCli.Views.{Search, Bookmarks, Lists, Aliases, Authentication, Help} 12 | 13 | @tabs [:search, :aliases, :bookmarks, :help] 14 | 15 | @impl true 16 | def init(_), do: State.init() 17 | 18 | @impl true 19 | def update(state, msg), do: State.update(state, msg) 20 | 21 | @impl true 22 | def render(%{token: nil} = state), do: Authentication.render(state) 23 | def render(%{tab: :search} = state), do: Search.render(state) 24 | def render(%{tab: :bookmarks} = state), do: Bookmarks.render(state) 25 | def render(%{tab: :aliases} = state), do: Aliases.render(state) 26 | def render(%{tab: :lists} = state), do: Lists.render(state) 27 | def render(%{tab: :help} = state), do: Help.render(state) 28 | 29 | @doc "Returns the available application tabs" 30 | def tabs, do: @tabs 31 | 32 | @impl true 33 | def subscribe(%{token: nil}), do: Subscription.interval(500, :check_token) 34 | def subscribe(_), do: Subscription.interval(100_000, :check_token) 35 | 36 | @doc "Returns the module responsible for the given tab" 37 | def view(type) do 38 | case type do 39 | :search -> Search 40 | :bookmarks -> Bookmarks 41 | :lists -> Lists 42 | :aliases -> Aliases 43 | :help -> Help 44 | end 45 | end 46 | end 47 | -------------------------------------------------------------------------------- /lib/tefter_cli/app/state.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.App.State do 2 | @moduledoc """ 3 | The main state management module 4 | """ 5 | 6 | require Logger 7 | import Ratatouille.Constants, only: [key: 1] 8 | 9 | alias TefterCli.Views.{Search, Bookmarks, Aliases, Help} 10 | 11 | @ctrl_b key(:ctrl_b) 12 | @ctrl_a key(:ctrl_a) 13 | @ctrl_l key(:ctrl_l) 14 | @search_keys [key(:ctrl_s), key(:home)] 15 | @ctrl_h key(:ctrl_h) 16 | @f5 key(:f5) 17 | @tab key(:tab) 18 | @escape key(:esc) 19 | 20 | @initial_state %{ 21 | query: "", 22 | tab: :search, 23 | token: nil, 24 | filter: nil, 25 | search: %{ 26 | resources: [], 27 | cursor: 0 28 | }, 29 | aliases: %{ 30 | resources: nil, 31 | filtered: [], 32 | cursor: 0 33 | }, 34 | bookmarks: %{ 35 | resources: nil, 36 | filtered: [], 37 | cursor: 0 38 | }, 39 | help: %{ 40 | cursor: 0 41 | } 42 | } 43 | 44 | def init do 45 | put_in(@initial_state[:token], TefterCli.Authentication.token()) 46 | end 47 | 48 | def update(state, msg) do 49 | Logger.info(inspect(msg)) 50 | 51 | case {state, msg} do 52 | {_, {:event, %{key: @escape}}} -> 53 | state 54 | |> put_in([:cmd], nil) 55 | |> put_in([:overlay], false) 56 | |> handle_command 57 | 58 | {%{token: nil}, :check_token} -> 59 | check_token(state) 60 | 61 | {_, {:event, %{key: @f5}}} -> 62 | IEx.Helpers.recompile() 63 | state 64 | 65 | {_, {:event, %{key: @tab}}} -> 66 | tabs = TefterCli.App.tabs() 67 | 68 | state 69 | |> put_in( 70 | [:tab], 71 | Enum.at(tabs, rem(Enum.find_index(tabs, &(&1 == state[:tab])) + 1, length(tabs))) 72 | ) 73 | 74 | {%{token: "" <> _}, {:event, %{key: key}}} when key in @search_keys -> 75 | put_in(state[:tab], :search) 76 | 77 | {%{token: "" <> _}, {:event, %{key: @ctrl_l}}} -> 78 | put_in(state[:tab], :lists) 79 | 80 | {%{token: "" <> _}, {:event, %{key: @ctrl_b}}} -> 81 | Bookmarks.init(state) 82 | 83 | {%{token: "" <> _}, {:event, %{key: @ctrl_h}}} -> 84 | put_in(state[:tab], :help) 85 | 86 | {%{token: "" <> _}, {:event, %{key: @ctrl_a}}} -> 87 | Aliases.init(state) 88 | 89 | {%{tab: :search}, _} -> 90 | Search.update(state, msg) 91 | 92 | {%{tab: :aliases}, _} -> 93 | Aliases.update(state, msg) 94 | 95 | {%{tab: :bookmarks}, _} -> 96 | Bookmarks.update(state, msg) 97 | 98 | {%{tab: :help}, _} -> 99 | Help.update(state, msg) 100 | 101 | _ -> 102 | state 103 | end 104 | end 105 | 106 | defp check_token(state) do 107 | case TefterCli.Authentication.token() do 108 | token when is_bitstring(token) -> put_in(state[:token], token) 109 | _ -> state 110 | end 111 | end 112 | 113 | defp handle_command(state) do 114 | TefterCli.App.view(state[:tab]).handle_command(state) 115 | end 116 | end 117 | -------------------------------------------------------------------------------- /lib/tefter_cli/application.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Application do 2 | # See https://hexdocs.pm/elixir/Application.html 3 | # for more information on OTP Applications 4 | @moduledoc false 5 | 6 | use Application 7 | 8 | def start(_type, _args) do 9 | Supervisor.start_link(children(), strategy: :one_for_one, name: TefterCli.Supervisor) 10 | end 11 | 12 | def stop(_) do 13 | System.halt() 14 | end 15 | 16 | defp children do 17 | [ 18 | { 19 | Ratatouille.Runtime.Supervisor, 20 | runtime: [app: TefterCli.App, quit_events: [{:key, Ratatouille.Constants.key(:ctrl_q)}]] 21 | }, 22 | %{ 23 | id: TefterCli.Authentication, 24 | start: {TefterCli.Authentication, :start_link, [%{}]}, 25 | restart: :transient 26 | } 27 | ] 28 | end 29 | end 30 | -------------------------------------------------------------------------------- /lib/tefter_cli/auth_server.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.AuthServer do 2 | @moduledoc """ 3 | A simple HTTP server to receive and decode the user's authentication token. 4 | See `TefterCli.Authentication` for more info about the authentication strategies. 5 | """ 6 | 7 | use Ace.HTTP.Service, port: 0, cleartext: true 8 | use Raxx.SimpleServer 9 | alias TefterCli.Config 10 | 11 | @impl Raxx.SimpleServer 12 | def handle_request(request, _) do 13 | with %{"hash" => encoded} <- get_query(request), 14 | {:ok, decoded} <- Base.url_decode64(encoded), 15 | {:ok, %{"token" => token, "username" => username}} <- Jason.decode(decoded), 16 | {:ok, _} <- Config.update(%{token: token, username: username}) do 17 | TefterCli.Authentication.stop_server() 18 | redirect("#{Tefter.base_url()}/integrations/auth_callbacks/cli", body: "Redirecting..") 19 | else 20 | _ -> 21 | response(:ok) 22 | |> set_header("content-type", "text/plain") 23 | |> set_body("Something went wrong while authenticating Tefter. Try restarting the app..") 24 | end 25 | end 26 | end 27 | -------------------------------------------------------------------------------- /lib/tefter_cli/authentication.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Authentication do 2 | @moduledoc """ 3 | The first time the application is started and there's no tefter config file with 4 | an authentication token, an HTTP server (see `TefterCli.AuthServer`) is started. 5 | 6 | Then we attempt to open a browser window pointing to an endpoint of Tefter which will 7 | redirect to a URL of the local server we started. The server will then decode the token 8 | and keep it in a file-backed config. 9 | """ 10 | 11 | use GenServer 12 | 13 | alias __MODULE__, as: Self 14 | 15 | def start_link(default), do: GenServer.start_link(Self, default, name: Self) 16 | 17 | def token, do: TefterCli.Config.all()[:token] 18 | 19 | def stop_server, do: Process.send_after(Process.whereis(Self), :stop_server, 10_000) 20 | 21 | def port, do: GenServer.call(Self, :port) 22 | 23 | def auth_url, do: auth_url(port()) 24 | 25 | defp auth_url(port) do 26 | "#{Tefter.base_url()}/integrations/auth_callbacks/cli?redir=http://localhost:#{port}/auth" 27 | end 28 | 29 | @impl true 30 | def init(_) do 31 | token = token() 32 | 33 | if token do 34 | {:ok, %{token: token}} 35 | else 36 | {:ok, server} = TefterCli.AuthServer.start_link(%{}) 37 | {:ok, port} = Ace.HTTP.Service.port(server) 38 | 39 | port |> auth_url |> TefterCli.System.open() 40 | 41 | {:ok, %{token: nil, server: server, port: port}} 42 | end 43 | end 44 | 45 | @impl true 46 | def handle_call(:port, _from, %{port: port} = state) do 47 | {:reply, port, state} 48 | end 49 | 50 | @impl true 51 | def handle_info(:stop_server, %{server: server} = state) do 52 | Process.unlink(server) 53 | GenServer.stop(server) 54 | 55 | {:noreply, Map.merge(state, %{server: nil, port: nil})} 56 | end 57 | end 58 | -------------------------------------------------------------------------------- /lib/tefter_cli/bookmarks.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Bookmarks do 2 | alias TefterCli.Cache 3 | 4 | def fetch(%{force: true}), do: Cache.update(:bookmarks, do_fetch()) 5 | def fetch(_), do: Cache.fetch(:bookmarks, fn -> do_fetch() end) 6 | 7 | defp do_fetch do 8 | case Tefter.bookmarks_export() do 9 | {:ok, %{status: 200, body: bookmarks}} -> bookmarks 10 | _ -> [] 11 | end 12 | end 13 | end 14 | -------------------------------------------------------------------------------- /lib/tefter_cli/cache.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Cache do 2 | @moduledoc """ 3 | File-backed cache 4 | The cache contents are kept as a JSON Object. 5 | """ 6 | 7 | @cache "~/.tefter_cache" 8 | 9 | @doc "Retrieve a value from the cache if exists, otherwise call the given function to initialise and return it" 10 | def fetch(key, fun) do 11 | read(key) || update(key, fun.()) 12 | end 13 | 14 | @doc "Return all the contents of the cache as a map" 15 | def read do 16 | with {:ok, f} <- File.read(cache_path()), 17 | {:ok, json} <- Jason.decode(f, keys: :atoms) do 18 | json 19 | else 20 | _ -> %{} 21 | end 22 | end 23 | 24 | @doc "Return a value of the cache" 25 | def read(key), do: read()[key] 26 | 27 | @doc "Update a value of the cache" 28 | def update(key, value) do 29 | with {:ok, json} <- read() |> put_in([key], value) |> Jason.encode(), 30 | File.write(cache_path(), json) do 31 | read(key) 32 | else 33 | error -> error 34 | end 35 | end 36 | 37 | defp cache_path, do: Path.expand(@cache) 38 | end 39 | -------------------------------------------------------------------------------- /lib/tefter_cli/command.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Command do 2 | @moduledoc """ 3 | Module handling input and state management for commands. 4 | TefterCli's commands are Vim-inspired. 5 | 6 | We trigger search when the user types `/`. 7 | There are also some context-aware colon commands. 8 | 9 | For example typing `:d` and hitting enter in the Aliases tab will delete the alias 10 | under the cursor. It'll delete a bookmark in the Bookmarks tab. 11 | 12 | To achieve that we delegate a `handle_command/1` with the current state to the active 13 | view module. Similarly when a command has been typed and the users hits enter, 14 | we delegate `run_command/1` with the current state. 15 | """ 16 | 17 | import Ratatouille.Constants, only: [key: 1] 18 | 19 | @enter [key(:enter), key(:mouse_left)] 20 | @space key(:space) 21 | @ctrl_u key(:ctrl_u) 22 | 23 | @delete_keys [ 24 | key(:delete), 25 | key(:backspace), 26 | key(:backspace2) 27 | ] 28 | 29 | def handle(state, msg) do 30 | cmd = state[:cmd] 31 | 32 | case msg do 33 | {:event, %{key: k}} when k in @enter -> 34 | run_command(state) 35 | 36 | {:event, %{ch: ?:}} when is_nil(cmd) -> 37 | state 38 | |> put_in([:cmd], ":") 39 | 40 | {:event, %{ch: ?/}} when is_nil(cmd) -> 41 | state 42 | |> put_in([:cmd], "/") 43 | 44 | {:event, %{key: @space}} when not is_nil(cmd) -> 45 | put_in(state[:cmd], cmd <> " ") 46 | 47 | {:event, %{key: key}} when key in @delete_keys and cmd == "" -> 48 | put_in(state[:cmd], nil) 49 | |> handle_command 50 | |> maybe_reset_cursor 51 | 52 | {:event, %{key: key}} when key in @delete_keys and is_nil(cmd) -> 53 | state 54 | 55 | {:event, %{key: @ctrl_u}} when is_nil(cmd) -> 56 | state 57 | 58 | {:event, %{key: @ctrl_u}} when not is_nil(cmd) -> 59 | put_in(state[:cmd], "") 60 | 61 | {:event, %{key: key}} when key in @delete_keys -> 62 | if String.length(cmd) > 0 do 63 | put_in(state[:cmd], String.slice(state[:cmd], 0..-2)) 64 | |> handle_command 65 | |> maybe_reset_cursor 66 | else 67 | state 68 | end 69 | 70 | {:event, %{ch: ch}} when ch > 0 and not is_nil(cmd) -> 71 | state 72 | |> put_in([:cmd], cmd <> <>) 73 | |> handle_command 74 | |> maybe_reset_cursor 75 | 76 | _ -> 77 | state 78 | end 79 | end 80 | 81 | @doc "Return true when a search command is active" 82 | def filter?(%{cmd: "/" <> _}), do: true 83 | def filter?(_), do: false 84 | 85 | defp run_command(%{cmd: ":h" <> _} = state) do 86 | state 87 | |> put_in([:cmd], nil) 88 | |> put_in([:tab], :help) 89 | end 90 | 91 | defp run_command(%{cmd: ":go " <> alias} = state) do 92 | TefterCli.System.open(%{path: "/go/#{alias}"}) 93 | 94 | state 95 | |> put_in([:cmd], nil) 96 | end 97 | 98 | defp run_command(%{cmd: ":q" <> _}), do: TefterCli.Application.stop(:ok) 99 | defp run_command(%{tab: type} = state), do: TefterCli.App.view(type).run_command(state) 100 | 101 | defp handle_command(%{tab: type} = state), do: TefterCli.App.view(type).handle_command(state) 102 | 103 | defp maybe_reset_cursor(%{cmd: ":" <> _} = state), do: state 104 | defp maybe_reset_cursor(%{cmd: "/" <> _} = state), do: reset_cursor(state) 105 | defp maybe_reset_cursor(%{cmd: cmd} = state) when cmd in [nil, ""], do: reset_cursor(state) 106 | defp maybe_reset_cursor(state), do: state 107 | 108 | defp reset_cursor(%{tab: type} = state), do: put_in(state, [type, :cursor], 0) 109 | end 110 | -------------------------------------------------------------------------------- /lib/tefter_cli/config.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Config do 2 | @moduledoc """ 3 | File-backed configuration. 4 | The config is meant to primarily store the authentication token of the user. 5 | """ 6 | 7 | @config "~/.tefter" 8 | @key :tefter_cli_config 9 | 10 | require Logger 11 | 12 | @doc "Return all the configuration" 13 | def all, do: :persistent_term.get(@key, do_all()) 14 | 15 | @doc "Update the configuration with values from a map" 16 | def update(map) do 17 | with new_conf <- Map.merge(all(), map), 18 | :ok <- :persistent_term.put(@key, new_conf), 19 | {:ok, json} <- Jason.encode(new_conf), 20 | :ok <- File.write(Path.expand(@config), json) do 21 | {:ok, new_conf} 22 | else 23 | other -> {:error, other} 24 | end 25 | end 26 | 27 | defp do_all do 28 | with {:ok, file} <- File.read(Path.expand(@config)), 29 | {:ok, conf} <- Jason.decode(file, keys: :atoms) do 30 | unless :persistent_term.get(@key, nil), do: :persistent_term.put(@key, conf) 31 | 32 | conf 33 | else 34 | _ -> %{} 35 | end 36 | end 37 | end 38 | -------------------------------------------------------------------------------- /lib/tefter_cli/system.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.System do 2 | @moduledoc """ 3 | Utility functions to interact with the OS 4 | """ 5 | 6 | def open(%{url: url}), do: open_url(url) 7 | def open(%{path: path}), do: open("#{Tefter.base_url()}/#{path}") 8 | def open(path) when is_bitstring(path), do: open_url(path) 9 | def open(_), do: :ok 10 | 11 | defp open_cmd do 12 | case :os.type() do 13 | {:unix, :linux} -> "xdg-open" 14 | {:unix, :darwin} -> "open" 15 | _ -> "start" 16 | end 17 | end 18 | 19 | defp open_url(url), do: Porcelain.spawn_shell("#{open_cmd()} #{url} 2>/dev/null &") 20 | end 21 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/aliases.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Aliases do 2 | @moduledoc """ 3 | View module for the aliases resources 4 | """ 5 | 6 | import Ratatouille.View 7 | import Ratatouille.Constants, only: [color: 1, attribute: 1] 8 | import TefterCli.Views.Helpers.Text, only: [highlight: 2] 9 | 10 | alias TefterCli.Views.Aliases.State 11 | alias TefterCli.Views.Components.{TopBar, BottomBar, InfoPanel} 12 | 13 | @style_header [ 14 | attributes: [attribute(:bold)] 15 | ] 16 | 17 | @style_selected [ 18 | color: color(:white), 19 | background: color(:magenta) 20 | ] 21 | 22 | @min_offset_y 5 23 | 24 | def init(state), do: State.init(state) 25 | 26 | def update(state, msg), do: State.update(state, msg) 27 | 28 | def render(%{tab: :aliases, aliases: %{resources: aliases, cursor: cursor}} = state) do 29 | filtered_state = put_in(state, [:aliases, :resources], State.filtered_aliases(state)) 30 | 31 | view bottom_bar: BottomBar.render(state) do 32 | panel title: TopBar.title(), height: :fill do 33 | panel title: "Aliases", height: 30, color: color(:green) do 34 | viewport(offset_y: offset_y(cursor)) do 35 | table do 36 | table_row(@style_header) do 37 | table_cell(content: "Name") 38 | table_cell(content: "URL") 39 | end 40 | 41 | case aliases do 42 | nil -> 43 | table_row do 44 | table_cell(content: "Loading..") 45 | table_cell(content: "") 46 | end 47 | 48 | [_ | _] -> 49 | for a <- Enum.with_index(filtered_state.aliases.resources), 50 | do: render_alias(state, a) 51 | 52 | [] -> 53 | table_row do 54 | table_cell(content: "You haven't created any aliases") 55 | table_cell(content: "") 56 | end 57 | end 58 | end 59 | end 60 | end 61 | 62 | InfoPanel.render(%{type: :aliases}, filtered_state) 63 | end 64 | end 65 | end 66 | 67 | def handle_command(s), do: State.handle_command(s) 68 | def run_command(s), do: State.run_command(s) 69 | 70 | defp render_alias(%{aliases: %{cursor: cursor}} = state, {%{name: name, url: url}, i}) do 71 | table_row(if cursor == i, do: @style_selected, else: []) do 72 | case state[:cmd] do 73 | "/" <> filter -> 74 | table_cell(content: name |> highlight(filter)) 75 | 76 | _ -> 77 | table_cell(content: name) 78 | end 79 | 80 | table_cell(content: url, color: color(:blue)) 81 | end 82 | end 83 | 84 | defp offset_y(cursor) when cursor < @min_offset_y, do: 0 85 | defp offset_y(cursor), do: cursor - @min_offset_y 86 | end 87 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/aliases/actions.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Aliases.Actions do 2 | @moduledoc """ 3 | Module handling interactions of Alias resources with Tefter 4 | """ 5 | 6 | def create(input) do 7 | with {:ok, input} <- process_input(input), 8 | {:ok, %{status: s, body: alias}} when s in 200..299 <- Tefter.create_alias(input) do 9 | {:ok, alias} 10 | else 11 | error -> error 12 | end 13 | end 14 | 15 | def delete(id) do 16 | case Tefter.delete_alias(%{id: id}) do 17 | {:ok, _} -> 18 | {:ok, id} 19 | 20 | error -> 21 | error 22 | end 23 | end 24 | 25 | defp process_input(input) do 26 | case String.split(input, " ") do 27 | [alias, url] -> {:ok, %{alias: alias, url: url}} 28 | _ -> {:error, :invalid_format} 29 | end 30 | end 31 | end 32 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/aliases/state.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Aliases.State do 2 | alias Ratatouille.Runtime.Command 3 | alias TefterCli.Views.Components.Cursor 4 | alias TefterCli.Views.Aliases.Actions 5 | 6 | import Ratatouille.Constants, only: [key: 1] 7 | 8 | @refresh key(:ctrl_r) 9 | 10 | def init(%{aliases: %{resources: nil}} = state) do 11 | put_in(state[:tab], :aliases) |> fetch_aliases 12 | end 13 | 14 | def init(state), do: put_in(state[:tab], :aliases) 15 | 16 | def update(%{aliases: %{cursor: _, resources: _}} = state, msg) do 17 | case msg do 18 | {:event, %{key: @refresh}} -> 19 | state 20 | |> put_in([:aliases, :resources], nil) 21 | |> fetch_aliases(%{force: true}) 22 | 23 | {:aliases_fetched, state} -> 24 | state 25 | 26 | msg -> 27 | case state |> TefterCli.Command.handle(msg) do 28 | {state, %Command{} = command} -> 29 | {Cursor.update(state, msg, %{type: :aliases}), command} 30 | 31 | state -> 32 | Cursor.update(state, msg, %{type: :aliases}) 33 | end 34 | end 35 | end 36 | 37 | defp fetch_aliases(state), do: fetch_aliases(state, %{force: false}) 38 | 39 | defp fetch_aliases(state, %{force: force}) do 40 | {state, 41 | Command.new( 42 | fn -> 43 | aliases = TefterCli.Aliases.fetch(%{force: force}) 44 | 45 | state |> put_in([:aliases, :resources], Enum.reverse(aliases)) 46 | end, 47 | :aliases_fetched 48 | )} 49 | end 50 | 51 | def handle_command(%{cmd: "/" <> _} = state) do 52 | apply_filters(state) 53 | end 54 | 55 | def handle_command(state), do: state 56 | 57 | def run_command(%{cmd: ":c " <> input} = state) do 58 | case Actions.create(input) do 59 | {:ok, _alias} -> 60 | state 61 | |> put_in([:cmd], nil) 62 | |> fetch_aliases(%{force: true}) 63 | 64 | _ -> 65 | state 66 | end 67 | end 68 | 69 | def run_command(%{cmd: ":e", aliases: %{resources: aliases, cursor: cursor}} = state) do 70 | with %{slug: id} <- Enum.at(aliases, cursor) do 71 | TefterCli.System.open(%{path: "aliases/#{id}/edit"}) 72 | else 73 | _ -> state 74 | end 75 | 76 | state |> put_in([:cmd], nil) 77 | end 78 | 79 | def run_command( 80 | %{cmd: ":d" <> _, aliases: %{resources: [_ | _] = aliases, cursor: cursor}} = state 81 | ) do 82 | with %{slug: id} <- Enum.at(aliases, cursor), 83 | {:ok, _} <- Actions.delete(id) do 84 | state 85 | |> put_in([:cmd], nil) 86 | |> fetch_aliases(%{force: true}) 87 | else 88 | _ -> state 89 | end 90 | end 91 | 92 | def run_command(%{cmd: ":" <> _} = state), do: put_in(state[:cmd], nil) 93 | def run_command(state), do: handle_enter(state) 94 | 95 | def handle_enter(%{aliases: %{cursor: cursor, resources: [_ | _]}} = state) do 96 | resources = if TefterCli.Command.filter?(state), do: :filtered, else: :resources 97 | 98 | TefterCli.System.open(Enum.at(state[:aliases][resources], cursor)) 99 | 100 | state 101 | end 102 | 103 | def filtered_aliases(%{aliases: %{resources: aliases}, cmd: filter}) when filter in [nil, "/"], 104 | do: aliases 105 | 106 | def filtered_aliases(%{aliases: %{resources: aliases}, cmd: "/" <> filter}) do 107 | regex = ~r/#{Regex.escape(filter)}/imu 108 | 109 | Enum.filter(aliases, fn %{name: name} -> 110 | String.match?(name, regex) 111 | end) 112 | end 113 | 114 | def filtered_aliases(%{aliases: %{resources: aliases}}), do: aliases 115 | 116 | defp apply_filters(state), do: put_in(state, [:aliases, :filtered], filtered_aliases(state)) 117 | end 118 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/authentication.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Authentication do 2 | @moduledoc """ 3 | View module for the authorisation screen displayed during the first run 4 | until an authorisation token is obtained. 5 | """ 6 | 7 | import Ratatouille.View 8 | import Ratatouille.Constants, only: [color: 1] 9 | 10 | alias TefterCli.Views.Components.{TopBar, BottomBar} 11 | 12 | def render(state) do 13 | view bottom_bar: BottomBar.render(state) do 14 | panel title: TopBar.title(), height: :fill do 15 | panel title: "Authentication", height: 30, color: color(:green) do 16 | row do 17 | column(size: 10) do 18 | panel do 19 | label do 20 | text(content: "Authenticating..") 21 | end 22 | end 23 | 24 | panel do 25 | label do 26 | text(content: authentication_message()) 27 | end 28 | 29 | label do 30 | text(content: TefterCli.Authentication.auth_url()) 31 | end 32 | end 33 | end 34 | end 35 | end 36 | end 37 | end 38 | end 39 | 40 | defp authentication_message do 41 | "If a browser window does not open automatically, open it by clicking on the link:" 42 | end 43 | end 44 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/bookmarks.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Bookmarks do 2 | @moduledoc """ 3 | View module for the bookmarks resource 4 | """ 5 | 6 | import Ratatouille.View 7 | import Ratatouille.Constants, only: [color: 1, attribute: 1] 8 | import TefterCli.Views.Helpers.Text, only: [truncate: 2, highlight: 2] 9 | 10 | alias TefterCli.Views.Bookmarks.State 11 | alias TefterCli.Views.Components.{TopBar, BottomBar, InfoPanel, Pagination} 12 | 13 | @style_header [ 14 | attributes: [attribute(:bold)] 15 | ] 16 | 17 | @style_selected [ 18 | color: color(:white), 19 | background: color(:magenta) 20 | ] 21 | 22 | @min_offset_y 5 23 | 24 | def init(%{bookmarks: %{resources: nil}} = state), 25 | do: put_in(state[:tab], :bookmarks) |> State.fetch_bookmarks() 26 | 27 | def init(state), do: put_in(state[:tab], :bookmarks) 28 | 29 | def render(%{tab: :bookmarks, bookmarks: %{resources: _bookmarks, cursor: _cursor}} = state) do 30 | filtered_state = put_in(state, [:bookmarks, :resources], State.filtered_bookmarks(state)) 31 | 32 | view bottom_bar: BottomBar.render(state) do 33 | if state[:overlay] do 34 | modal(state[:overlay]) 35 | else 36 | content(filtered_state) 37 | end 38 | end 39 | end 40 | 41 | def update(state, msg), do: TefterCli.Views.Bookmarks.State.update(state, msg) 42 | 43 | def handle_command(s), do: State.handle_command(s) 44 | 45 | def run_command(s), do: State.run_command(s) 46 | 47 | defp render_bookmark( 48 | %{bookmarks: %{cursor: cursor, resources: bookmarks}} = state, 49 | {%{title: title, url: url} = bookmark, _i} 50 | ) do 51 | table_row(if Enum.at(bookmarks, cursor) == bookmark, do: @style_selected, else: []) do 52 | case state[:cmd] do 53 | "/" <> filter -> 54 | table_cell(content: title |> truncate(70) |> highlight(filter)) 55 | 56 | _ -> 57 | table_cell(content: title |> truncate(70)) 58 | end 59 | 60 | table_cell(content: url, color: color(:blue)) 61 | end 62 | end 63 | 64 | defp content(%{bookmarks: %{resources: bookmarks, cursor: cursor}} = state) do 65 | cmd = state[:cmd] 66 | 67 | panel title: TopBar.title(), height: :fill do 68 | current_bookmark_panel(state) 69 | 70 | panel title: "Bookmarks", 71 | height: Pagination.page_size() + @min_offset_y, 72 | color: color(:green) do 73 | viewport(offset_y: 0) do 74 | table do 75 | table_row(@style_header) do 76 | table_cell(content: "Title") 77 | table_cell(content: "URL") 78 | end 79 | 80 | case bookmarks do 81 | nil -> 82 | table_row do 83 | table_cell(content: "Loading..") 84 | table_cell(content: "") 85 | end 86 | 87 | [_ | _] -> 88 | for a <- Enum.with_index(Pagination.page_slice(state.bookmarks.resources, cursor)) do 89 | render_bookmark(state, a) 90 | end 91 | 92 | [] when is_nil(cmd) -> 93 | table_row do 94 | table_cell(content: "You haven't added any bookmarks") 95 | table_cell(content: "") 96 | end 97 | 98 | [] -> 99 | table_row do 100 | table_cell(content: "") 101 | table_cell(content: "") 102 | end 103 | end 104 | end 105 | end 106 | end 107 | 108 | InfoPanel.render(%{type: :bookmarks}, state) 109 | end 110 | end 111 | 112 | defp current_bookmark_panel(%{bookmarks: %{resources: b}}) when b in [nil, []] do 113 | row do 114 | column(size: 2) do 115 | label do 116 | text(content: "") 117 | end 118 | end 119 | end 120 | end 121 | 122 | defp current_bookmark_panel(%{bookmarks: %{resources: bookmarks, cursor: cursor}}) do 123 | bookmark = Enum.at(bookmarks, cursor) 124 | 125 | row do 126 | column(size: 8) do 127 | panel title: "URL" do 128 | label do 129 | text(content: bookmark[:url]) 130 | end 131 | end 132 | end 133 | 134 | if length(bookmark[:tags] || []) > 0 do 135 | column(size: 4) do 136 | panel title: "Tags" do 137 | label do 138 | text(content: bookmark[:tags] |> Enum.join(", ") |> truncate(40)) 139 | end 140 | end 141 | end 142 | end 143 | end 144 | end 145 | 146 | defp modal({:show_bookmark, %{title: title, tags: tags, lists: lists, notes: notes}}) do 147 | overlay do 148 | panel title: "Title" do 149 | label do 150 | text(content: title) 151 | end 152 | end 153 | 154 | if length(tags) > 0 do 155 | panel title: "Tags" do 156 | label do 157 | text(content: tags |> Enum.join(", ")) 158 | end 159 | end 160 | end 161 | 162 | if length(lists) > 0 do 163 | panel title: "Lists" do 164 | label do 165 | text(content: lists |> Enum.join(", ")) 166 | end 167 | end 168 | end 169 | 170 | panel title: "Notes", height: 10 do 171 | label do 172 | text(content: notes) 173 | end 174 | end 175 | end 176 | end 177 | 178 | defp modal(_) do 179 | # Show an empty modal in case of bad data 180 | overlay do 181 | end 182 | end 183 | end 184 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/bookmarks/actions.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Bookmarks.Actions do 2 | @moduledoc """ 3 | Module handling interactions of Bookmark resources with Tefter 4 | """ 5 | 6 | alias TefterCli.Cache 7 | 8 | def create(url) do 9 | case Tefter.create_bookmark(%{url: url}) do 10 | {:ok, %{status: s, body: bookmark}} when s in 200..299 -> {:ok, bookmark} 11 | error -> error 12 | end 13 | end 14 | 15 | def delete(id) do 16 | case Tefter.delete_bookmark(%{id: id}) do 17 | {:ok, _} -> 18 | updated_bookmarks = Cache.read(:bookmarks) |> Enum.reject(&match?(%{id: ^id}, &1)) 19 | Cache.update(:bookmarks, updated_bookmarks) 20 | 21 | {:ok, updated_bookmarks} 22 | 23 | error -> 24 | error 25 | end 26 | end 27 | end 28 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/bookmarks/state.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Bookmarks.State do 2 | alias Ratatouille.Runtime.Command 3 | alias TefterCli.Views.Components.Cursor 4 | alias TefterCli.Views.Bookmarks.Actions 5 | 6 | import Ratatouille.Constants, only: [key: 1] 7 | 8 | @refresh key(:ctrl_r) 9 | 10 | def update(%{bookmarks: %{cursor: _, resources: _bookmarks}} = state, msg) do 11 | case msg do 12 | {:event, %{key: @refresh}} -> 13 | state 14 | |> put_in([:bookmarks, :resources], nil) 15 | |> fetch_bookmarks(%{force: true}) 16 | 17 | {:bookmarks_fetched, state} -> 18 | state 19 | 20 | msg -> 21 | case state |> TefterCli.Command.handle(msg) do 22 | {state, %Command{} = command} -> 23 | {Cursor.update(state, msg, %{type: :bookmarks}), command} 24 | 25 | state -> 26 | Cursor.update(state, msg, %{type: :bookmarks}) 27 | end 28 | end 29 | end 30 | 31 | def filtered_bookmarks(%{bookmarks: %{resources: bookmarks}, cmd: filter}) 32 | when filter in [nil, "/"], 33 | do: bookmarks 34 | 35 | def filtered_bookmarks(%{bookmarks: %{resources: bookmarks}, cmd: "/" <> filter}) do 36 | regex = ~r/#{Regex.escape(filter)}/imu 37 | 38 | Enum.filter(bookmarks, fn %{title: title} -> 39 | String.match?(title, regex) 40 | end) 41 | end 42 | 43 | def filtered_bookmarks(%{bookmarks: %{resources: bookmarks}}), do: bookmarks 44 | 45 | def fetch_bookmarks(state), do: fetch_bookmarks(state, %{force: false}) 46 | 47 | def fetch_bookmarks(state, %{force: force}) do 48 | {state, 49 | Command.new( 50 | fn -> 51 | bookmarks = TefterCli.Bookmarks.fetch(%{force: force}) 52 | 53 | state 54 | |> put_in([:bookmarks, :resources], Enum.reverse(bookmarks)) 55 | end, 56 | :bookmarks_fetched 57 | )} 58 | end 59 | 60 | def handle_command(%{cmd: "/" <> _} = state) do 61 | apply_filters(state) 62 | end 63 | 64 | def handle_command(state), do: state 65 | 66 | def handle_enter(%{cmd: ":" <> _} = state) do 67 | run_command(state) 68 | end 69 | 70 | def handle_enter(%{bookmarks: %{cursor: cursor, resources: [_ | _]}} = state) do 71 | resources = if TefterCli.Command.filter?(state), do: :filtered, else: :resources 72 | 73 | TefterCli.System.open(Enum.at(state[:bookmarks][resources], cursor)[:url]) 74 | 75 | state 76 | end 77 | 78 | def run_command(%{cmd: ":d" <> _, bookmarks: %{resources: bookmarks, cursor: cursor}} = state) do 79 | with %{id: id} <- Enum.at(bookmarks, cursor), 80 | {:ok, updated_bookmarks} <- Actions.delete(id) do 81 | state 82 | |> put_in([:cmd], nil) 83 | |> put_in([:bookmarks, :resources], updated_bookmarks) 84 | else 85 | _ -> state 86 | end 87 | end 88 | 89 | def run_command(%{cmd: ":e", bookmarks: %{resources: bookmarks, cursor: cursor}} = state) do 90 | with %{id: id} <- Enum.at(bookmarks, cursor) do 91 | TefterCli.System.open(%{path: "bookmarks/#{id}/edit"}) 92 | else 93 | _ -> state 94 | end 95 | 96 | state |> put_in([:cmd], nil) 97 | end 98 | 99 | def run_command(%{cmd: ":c " <> url} = state) do 100 | case Actions.create(url) do 101 | {:ok, _bookmark} -> 102 | state 103 | |> put_in([:cmd], nil) 104 | |> fetch_bookmarks(%{force: true}) 105 | 106 | _ -> 107 | state 108 | end 109 | end 110 | 111 | def run_command(%{cmd: ":s", bookmarks: %{resources: bookmarks, cursor: cursor}} = state) do 112 | bookmark = Enum.at(bookmarks, cursor) 113 | 114 | put_in(state[:overlay], {:show_bookmark, bookmark}) 115 | end 116 | 117 | def run_command(%{cmd: ":" <> _} = state), do: put_in(state[:cmd], nil) 118 | def run_command(state), do: handle_enter(state) 119 | 120 | defp apply_filters(state), do: put_in(state, [:bookmarks, :filtered], filtered_bookmarks(state)) 121 | end 122 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/components/bottom_bar.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Components.BottomBar do 2 | @moduledoc """ 3 | Re-usable component for bottom bar display. 4 | Renders the available tabs, username and command status. 5 | """ 6 | 7 | import Ratatouille.View 8 | 9 | alias TefterCli.Config 10 | 11 | def render(%{tab: tab} = state) do 12 | bar do 13 | label do 14 | for <> <> rest = t <- Enum.map(TefterCli.App.tabs(), &to_string/1) do 15 | initial = List.to_string([c]) |> String.upcase() 16 | content = " [#{initial}]#{rest} " 17 | 18 | if to_string(tab) == t do 19 | text( 20 | background: :green, 21 | color: :black, 22 | content: content 23 | ) 24 | else 25 | text(content: content) 26 | end 27 | end 28 | 29 | case Config.all()[:username] do 30 | u when is_bitstring(u) -> text(content: "║ User: #{u} ") 31 | _ -> nil 32 | end 33 | 34 | text(content: "║ Mode: ") 35 | 36 | case state[:cmd] do 37 | "" <> _ -> text(content: " COMMAND ", color: :magenta, background: :cyan) 38 | _ -> text(content: " NORMAL ", color: :white, background: :black) 39 | end 40 | end 41 | end 42 | end 43 | end 44 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/components/cursor.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Components.Cursor do 2 | @moduledoc """ 3 | State management module for tabular views. 4 | """ 5 | 6 | import Ratatouille.Constants, only: [key: 1] 7 | alias TefterCli.Views.Components.Pagination 8 | 9 | @up [key(:arrow_up), key(:mouse_wheel_up), key(:ctrl_k), key(:ctrl_p)] 10 | @down [key(:arrow_down), key(:mouse_wheel_down), key(:ctrl_j), key(:ctrl_n)] 11 | @next_page [key(:ctrl_d)] 12 | @previous_page [key(:ctrl_u)] 13 | 14 | def update(state, msg, %{type: type}) do 15 | cursor = state[type][:cursor] 16 | resources_type = if TefterCli.Command.filter?(state), do: :filtered, else: :resources 17 | resources = state[type][resources_type] 18 | scroll_size = round(Pagination.page_size() / 2) 19 | resource_len = length(resources) 20 | 21 | case msg do 22 | _ when resources == [] -> 23 | state 24 | 25 | {:event, %{key: k}} when k in @up and cursor > 0 -> 26 | put_in(state, [type, :cursor], cursor - 1) 27 | 28 | {:event, %{key: k}} when k in @up -> 29 | put_in(state, [type, :cursor], resource_len - 1) 30 | 31 | {:event, %{key: k}} when k in @down and cursor < resource_len - 1 -> 32 | put_in(state, [type, :cursor], cursor + 1) 33 | 34 | {:event, %{key: k}} when k in @down -> 35 | put_in(state, [type, :cursor], 0) 36 | 37 | {:event, %{key: k}} when k in @next_page and cursor + scroll_size >= resource_len - 1 -> 38 | put_in(state, [type, :cursor], resource_len - 1) 39 | 40 | {:event, %{key: k}} when k in @next_page -> 41 | put_in(state, [type, :cursor], cursor + scroll_size) 42 | 43 | {:event, %{key: k}} when k in @previous_page and cursor - scroll_size >= 0 -> 44 | put_in(state, [type, :cursor], cursor - scroll_size) 45 | 46 | {:event, %{key: k}} when k in @previous_page -> 47 | put_in(state, [type, :cursor], 0) 48 | 49 | _ -> 50 | state 51 | end 52 | end 53 | end 54 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/components/info_panel.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Components.InfoPanel do 2 | @moduledoc """ 3 | Re-usable component for tabular views. 4 | It displays commands and pagination info. 5 | """ 6 | 7 | import Ratatouille.View 8 | import Ratatouille.Constants, only: [color: 1] 9 | 10 | alias TefterCli.Views.Components.Pagination 11 | 12 | def render(%{type: type}, state) do 13 | cmd = state[:cmd] 14 | 15 | row do 16 | column(size: 9) do 17 | if state[:cmd] do 18 | panel title: "Command", color: color(:yellow) do 19 | label do 20 | text(content: cmd) 21 | end 22 | end 23 | else 24 | label do 25 | text(content: "") 26 | end 27 | end 28 | end 29 | 30 | column(size: 3) do 31 | panel title: "Info" do 32 | label do 33 | text(content: pagination_label(type, state)) 34 | end 35 | end 36 | end 37 | end 38 | end 39 | 40 | defp pagination_label(type, state) do 41 | case state[type] do 42 | %{resources: r} when r in [nil, []] -> 43 | "" 44 | 45 | %{resources: resources, cursor: cursor} -> 46 | "Page: #{Pagination.page(resources, cursor) + 1} / #{Pagination.total_pages(resources)} Total: #{ 47 | length(resources) 48 | }" 49 | 50 | _ -> 51 | "" 52 | end 53 | end 54 | end 55 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/components/pagination.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Components.Pagination do 2 | @moduledoc """ 3 | Utility functions for paginated resources 4 | """ 5 | 6 | @page_size 20 7 | 8 | def page_size, do: @page_size 9 | 10 | def total_pages([_ | _] = resources), do: round(:math.ceil(length(resources) / @page_size)) 11 | def total_pages(_), do: 0 12 | 13 | def page(_resources, cursor), do: div(cursor, @page_size) 14 | 15 | def page_slice(resources, cursor), 16 | do: Enum.slice(resources, page(resources, cursor) * @page_size, @page_size) 17 | end 18 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/components/top_bar.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Components.TopBar do 2 | @doc "Returns the title to put in the titlebar" 3 | def title do 4 | "Tefter v#{TefterCli.version()} (ctrl-q to exit) (ctrl-h for help)" 5 | end 6 | end 7 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/help.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Help do 2 | @moduledoc """ 3 | View module for Help 4 | """ 5 | 6 | import Ratatouille.View 7 | import Ratatouille.Constants, only: [color: 1, attribute: 1] 8 | 9 | alias TefterCli.Views.Components.{BottomBar, TopBar} 10 | 11 | @bold attribute(:bold) 12 | 13 | def render(%{help: %{cursor: cursor}} = state) do 14 | view bottom_bar: BottomBar.render(state) do 15 | viewport(offset_y: cursor) do 16 | panel title: TopBar.title(), height: :fill do 17 | row do 18 | column(size: 12) do 19 | label() 20 | 21 | label( 22 | content: "Tefter v#{TefterCli.version()}", 23 | attributes: [@bold], 24 | color: color(:magenta) 25 | ) 26 | 27 | label(content: "Source / Issues: https://github.com/tefter/cli") 28 | label(content: "Questions: support@tefter.io") 29 | label() 30 | 31 | label( 32 | content: "Use the j and k keys to scroll in help", 33 | attributes: [@bold], 34 | color: color(:magenta) 35 | ) 36 | 37 | label( 38 | content: "Min recommended terminal dimensions: 37 x 154", 39 | color: color(:yellow) 40 | ) 41 | 42 | label() 43 | label(content: "Keyboard Controls", attributes: [@bold]) 44 | label() 45 | label(content: "Tabs / Panes") 46 | 47 | control_label( 48 | "ctrl-s", 49 | "Search (Search for bookmarks / lists / aliases)" 50 | ) 51 | 52 | control_label("ctrl-a", "Aliases (Displays your aliases)") 53 | control_label("ctrl-b", "Bookmarks (Displays your bookmarks)") 54 | control_label("ctrl-h", "Help (Shows this help screen)") 55 | control_label("tab ", "Switches to the next tab") 56 | control_label("home ", "Switches to the first tab") 57 | label() 58 | label(content: "Navigation / Actions") 59 | control_label("UP/DOWN ctrl-j/ctrl-k or mouse wheel ", "Scroll vertically") 60 | 61 | control_label( 62 | "ctrl-d/ctrl-u ", 63 | "Scroll up / down by half a page" 64 | ) 65 | 66 | control_label( 67 | "enter ", 68 | "Open a result in the browser" 69 | ) 70 | 71 | control_label("ctrl-d ", "Exit") 72 | control_label("ctrl-r ", "Refresh results") 73 | control_label("/ ", "Search") 74 | control_label("escape ", "Clear search / command") 75 | label() 76 | label(content: "General Commands") 77 | control_label(":h ", "Shows this help screen") 78 | control_label(":q ", "Exit") 79 | label() 80 | label(content: "Bookmark Commands") 81 | control_label(":c ", "Bookmarks the given URL") 82 | 83 | control_label( 84 | ":e ", 85 | "Edits the selected bookmark" 86 | ) 87 | 88 | control_label( 89 | ":d ", 90 | "Deletes the bookmark under the cursor" 91 | ) 92 | 93 | control_label( 94 | ":s ", 95 | "Displays info about the selected bookmark" 96 | ) 97 | 98 | label() 99 | label(content: "Alias Commands") 100 | control_label(":c ", "Creates an alias") 101 | control_label(":e ", "Edits the selected alias") 102 | 103 | control_label( 104 | ":d ", 105 | "Deletes the alias under the cursor" 106 | ) 107 | 108 | control_label( 109 | ":go ", 110 | "Navigates to the given alias" 111 | ) 112 | end 113 | end 114 | end 115 | end 116 | end 117 | end 118 | 119 | def update(%{help: %{cursor: cursor}} = state, msg) do 120 | case {state, msg} do 121 | {_, {:event, %{ch: ?j}}} -> 122 | put_in(state, [:help, :cursor], cursor + 1) 123 | 124 | {_, {:event, %{ch: ?k}}} when cursor > 0 -> 125 | put_in(state, [:help, :cursor], cursor - 1) 126 | 127 | _ -> 128 | state 129 | end 130 | end 131 | 132 | def handle_command(state), do: state 133 | 134 | defp control_label(keys, description) do 135 | label do 136 | text(attributes: [@bold], content: " #{keys}") 137 | text(content: " #{description}") 138 | end 139 | end 140 | end 141 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/helpers/text.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Helpers.Text do 2 | @underline <<818::utf8>> 3 | 4 | def truncate(text, size) do 5 | if String.length(text) > size do 6 | "#{String.slice(text, 0..size)}…" 7 | else 8 | text 9 | end 10 | end 11 | 12 | def highlight(text, nil), do: text 13 | def highlight(text, ""), do: text 14 | def highlight(text, pattern), do: Regex.replace(~r/#{pattern}/imu, text, &"[#{&1}]") 15 | 16 | def underline(text) do 17 | for c <- String.codepoints(text), into: "", do: "#{c}#{@underline}" 18 | end 19 | end 20 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/lists.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Lists do 2 | @moduledoc """ 3 | (Placeholder) View module for list resources 4 | """ 5 | 6 | import Ratatouille.View 7 | 8 | alias TefterCli.Views.Components.{TopBar, BottomBar} 9 | import Ratatouille.Constants, only: [color: 1] 10 | 11 | def render(state) do 12 | view bottom_bar: BottomBar.render(state) do 13 | panel title: TopBar.title(), height: :fill do 14 | panel title: "Lists", height: 30, color: color(:green) do 15 | row do 16 | column(size: 10) do 17 | panel do 18 | label do 19 | text(content: "List 1") 20 | end 21 | end 22 | end 23 | end 24 | 25 | row do 26 | column(size: 10) do 27 | panel do 28 | label do 29 | text(content: "List 2") 30 | end 31 | end 32 | end 33 | end 34 | end 35 | end 36 | end 37 | end 38 | end 39 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/search.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Search do 2 | @moduledoc """ 3 | View module for search 4 | """ 5 | 6 | import Ratatouille.View 7 | import Ratatouille.Constants, only: [color: 1] 8 | 9 | alias TefterCli.Views.Search.State 10 | alias TefterCli.Views.Components.{TopBar, BottomBar} 11 | 12 | def render(state) do 13 | view bottom_bar: BottomBar.render(state) do 14 | panel title: TopBar.title(), height: :fill do 15 | row do 16 | column(size: 6) do 17 | panel title: "Search", color: color(:blue) do 18 | label(content: state[:query] <> "▌") 19 | end 20 | end 21 | 22 | column(size: 6) do 23 | panel title: "Info" do 24 | label do 25 | text(content: "Open: return. Move: ctrl-j / ctrl-k") 26 | end 27 | end 28 | end 29 | end 30 | 31 | panel title: "Results", height: 20, color: color(:green) do 32 | case state.search.resources do 33 | [_ | _] -> 34 | for r <- Enum.with_index(state.search.resources), do: render_result(state, r) 35 | 36 | [] -> 37 | label do 38 | text(content: "") 39 | end 40 | 41 | _ -> 42 | label do 43 | text(content: "Start typing to search.") 44 | end 45 | end 46 | end 47 | end 48 | end 49 | end 50 | 51 | def update(state, msg), do: State.update(state, msg) 52 | 53 | def handle_command(s), do: State.handle_command(s) 54 | 55 | defp render_result(%{search: %{cursor: cursor}}, {%{"name" => name} = result, i}) do 56 | row do 57 | column(size: 10) do 58 | label do 59 | result_cursor(cursor, i) 60 | result_icon(result) 61 | text(content: " " <> name) 62 | end 63 | end 64 | end 65 | end 66 | 67 | defp result_cursor(cursor, cursor), do: text(content: "▶ ", color: color(:green)) 68 | defp result_cursor(_, _), do: text(content: "") 69 | 70 | defp result_icon(%{"title" => title}) do 71 | case {:os.type(), title} do 72 | {{_, :darwin}, "Domain"} -> text(content: "🌍 ") 73 | {{_, :darwin}, "List"} -> text(content: "📂 ") 74 | {{_, :darwin}, "Tag"} -> text(content: "🏷 ") 75 | {{_, :darwin}, "Bookmark"} -> text(content: "📘 ") 76 | {{_, :darwin}, "Alias"} -> text(content: "✨ ") 77 | {_, other} -> text(content: "[#{other}]" <> " ") 78 | end 79 | end 80 | end 81 | -------------------------------------------------------------------------------- /lib/tefter_cli/views/search/state.ex: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.Views.Search.State do 2 | @moduledoc """ 3 | State management module for search 4 | """ 5 | 6 | import Ratatouille.Constants, only: [key: 1] 7 | alias Ratatouille.Runtime.Command 8 | 9 | @enter [key(:enter), key(:mouse_left)] 10 | @space key(:space) 11 | @delete_keys [ 12 | key(:delete), 13 | key(:backspace), 14 | key(:backspace2) 15 | ] 16 | @up [key(:arrow_up), key(:mouse_wheel_up), key(:ctrl_k), key(:ctrl_p)] 17 | @down [key(:arrow_down), key(:mouse_wheel_down), key(:ctrl_j), key(:ctrl_n)] 18 | @debug key(:ctrl_y) 19 | @ctrl_u key(:ctrl_u) 20 | 21 | def update(%{query: query, search: %{cursor: cursor, resources: results}} = state, msg) do 22 | case msg do 23 | {:event, %{key: @debug}} -> 24 | raise "Get me out of here" 25 | 26 | {:event, %{key: k}} when k in @enter -> 27 | TefterCli.System.open(Enum.at(results, cursor)) 28 | state 29 | 30 | {:event, %{key: @ctrl_u}} -> 31 | state 32 | |> put_in([:query], "") 33 | |> put_in([:search, :resources], []) 34 | 35 | {:event, %{key: key}} when key in @delete_keys -> 36 | put_in(state[:query], String.slice(query, 0..-2)) 37 | |> search 38 | 39 | {:event, %{key: @space}} -> 40 | put_in(state[:query], query <> " ") 41 | |> search 42 | 43 | {:event, %{key: k}} when k in @up and cursor > 0 -> 44 | put_in(state, [:search, :cursor], cursor - 1) 45 | 46 | {:event, %{key: k}} when k in @up -> 47 | put_in(state, [:search, :cursor], length(results) - 1) 48 | 49 | {:event, %{key: k}} when k in @down and cursor < length(results) - 1 -> 50 | put_in(state, [:search, :cursor], cursor + 1) 51 | 52 | {:event, %{key: k}} when k in @down -> 53 | put_in(state, [:search, :cursor], 0) 54 | 55 | {:event, %{ch: ch}} when ch > 0 -> 56 | put_in(state[:query], query <> <>) 57 | |> search 58 | 59 | {:search_completed, state} -> 60 | put_in(state[:query], query) 61 | 62 | _ -> 63 | state 64 | end 65 | end 66 | 67 | def handle_command(state), do: state 68 | 69 | defp format_search(state, suggestions) do 70 | new_state = 71 | put_in( 72 | state, 73 | [:search, :resources], 74 | suggestions 75 | |> Enum.map(& &1["suggestions"]) 76 | |> List.flatten() 77 | |> Enum.take(8) 78 | ) 79 | 80 | new_state 81 | end 82 | 83 | defp search(%{query: query} = state) do 84 | {state, 85 | Command.new( 86 | fn -> 87 | case Tefter.suggestions(%{query: query}) do 88 | {:ok, %{body: %{"suggestions" => s}}} -> format_search(state, s) 89 | _ -> state 90 | end 91 | end, 92 | :search_completed 93 | )} 94 | end 95 | end 96 | -------------------------------------------------------------------------------- /log/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tefter/cli/8275a5217f8f9eace44f68362af5339e8ad5837d/log/.keep -------------------------------------------------------------------------------- /mix.exs: -------------------------------------------------------------------------------- 1 | defmodule TefterCli.MixProject do 2 | use Mix.Project 3 | 4 | def project do 5 | [ 6 | app: :tefter_cli, 7 | version: "0.2.0", 8 | elixir: "~> 1.9", 9 | start_permanent: Mix.env() == :prod, 10 | deps: deps() 11 | ] 12 | end 13 | 14 | def application do 15 | [ 16 | extra_applications: [:logger], 17 | mod: {TefterCli.Application, []} 18 | ] 19 | end 20 | 21 | defp deps do 22 | [ 23 | {:ratatouille, "~> 0.5.0"}, 24 | {:tesla, "~> 1.2.0"}, 25 | {:jason, "~> 1.1"}, 26 | {:logger_file_backend, "~> 0.0.11"}, 27 | {:ace, "~> 0.18"}, 28 | {:porcelain, "~> 2.0"} 29 | ] 30 | end 31 | end 32 | -------------------------------------------------------------------------------- /mix.lock: -------------------------------------------------------------------------------- 1 | %{ 2 | "ace": {:hex, :ace, "0.18.10", "b471853b9da7acc1bd8df73749db832f99eef8555bab7d90de3854bda93b1dc8", [:mix], [{:hpack, "~> 0.2.3", [hex: :hpack_erl, repo: "hexpm", optional: false]}, {:raxx, "~> 0.17.0 or ~> 0.18.0 or ~> 1.0", [hex: :raxx, repo: "hexpm", optional: false]}], "hexpm"}, 3 | "asciichart": {:hex, :asciichart, "1.0.0", "6ef5dbeab545cb7a0bdce7235958f129de6cd8ad193684dc0953c9a8b4c3db5b", [:mix], [], "hexpm"}, 4 | "elixir_make": {:hex, :elixir_make, "0.6.0", "38349f3e29aff4864352084fc736fa7fa0f2995a819a737554f7ebd28b85aaab", [:mix], [], "hexpm"}, 5 | "ex_termbox": {:hex, :ex_termbox, "1.0.0", "6f26a0cdc787c0685732649beee6973248504fc689776cf57a485422be8dac4b", [:make, :mix], [{:elixir_make, "~> 0.4", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm"}, 6 | "hpack": {:hex, :hpack_erl, "0.2.3", "17670f83ff984ae6cd74b1c456edde906d27ff013740ee4d9efaa4f1bf999633", [:rebar3], [], "hexpm"}, 7 | "jason": {:hex, :jason, "1.1.2", "b03dedea67a99223a2eaf9f1264ce37154564de899fd3d8b9a21b1a6fd64afe7", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm"}, 8 | "logger_file_backend": {:hex, :logger_file_backend, "0.0.11", "3bbc5f31d3669e8d09d7a9443e86056fae7fc18e45c6f748c33b8c79a7e147a1", [:mix], [], "hexpm"}, 9 | "mime": {:hex, :mime, "1.3.1", "30ce04ab3175b6ad0bdce0035cba77bba68b813d523d1aac73d9781b4d193cf8", [:mix], [], "hexpm"}, 10 | "porcelain": {:hex, :porcelain, "2.0.3", "2d77b17d1f21fed875b8c5ecba72a01533db2013bd2e5e62c6d286c029150fdc", [:mix], [], "hexpm"}, 11 | "ratatouille": {:hex, :ratatouille, "0.5.0", "e843c2dbc0293438865361c4e4fecf5bab702563e490d67dee85edcabf15ac1d", [:mix], [{:asciichart, "~> 1.0", [hex: :asciichart, repo: "hexpm", optional: false]}, {:ex_termbox, "~> 1.0", [hex: :ex_termbox, repo: "hexpm", optional: false]}], "hexpm"}, 12 | "raxx": {:hex, :raxx, "1.1.0", "d6a03143a91f8092c0be1ec555075c76c8d680601236de706f020d17abcf8b16", [:mix], [], "hexpm"}, 13 | "tesla": {:hex, :tesla, "1.2.1", "864783cc27f71dd8c8969163704752476cec0f3a51eb3b06393b3971dc9733ff", [:mix], [{:exjsx, ">= 3.0.0", [hex: :exjsx, repo: "hexpm", optional: true]}, {:fuse, "~> 2.4", [hex: :fuse, repo: "hexpm", optional: true]}, {:hackney, "~> 1.6", [hex: :hackney, repo: "hexpm", optional: true]}, {:ibrowse, "~> 4.4.0", [hex: :ibrowse, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}, {:poison, ">= 1.0.0", [hex: :poison, repo: "hexpm", optional: true]}], "hexpm"}, 14 | } 15 | -------------------------------------------------------------------------------- /test/tefter_cli_test.exs: -------------------------------------------------------------------------------- 1 | defmodule TefterCliTest do 2 | use ExUnit.Case 3 | doctest TefterCli 4 | 5 | test "greets the world" do 6 | assert TefterCli.hello() == :world 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /test/test_helper.exs: -------------------------------------------------------------------------------- 1 | ExUnit.start() 2 | --------------------------------------------------------------------------------