ofe 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +19 -0
  3. data/LICENSE +340 -0
  4. data/README.md +107 -0
  5. data/Rakefile +30 -0
  6. data/bin/ofe +14 -0
  7. data/lib/ofe.rb +312 -0
  8. data/lib/ofe/t_sorted_files.rb +49 -0
  9. data/ofe.gemspec +69 -0
  10. data/ofe.json +16 -0
  11. metadata +156 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0e822f9f944494e3350388ace5d08728b3ee8f7f
4
+ data.tar.gz: 4d7da5865242ecf2d690663f25a222cdff88cb99
5
+ SHA512:
6
+ metadata.gz: 5c0be2929f3a51d3e875aa9d47234bc27b82694cc72687f817e4e302f89dc0cb5103658125e042bf011d0411ea03f32ecda3cb183e89bc3875a917e9914d40fd
7
+ data.tar.gz: dae7e50034a7026de71f0a26eda9adbf4635d047d8716cd2d83693d551e616dcaae89b4664ca676b41aecb774faace67b83060155765af41e64ac04c24cf2006
data/Gemfile ADDED
@@ -0,0 +1,19 @@
1
+ # ================================================
2
+ # GEMFILE ========================================
3
+ # ================================================
4
+
5
+ # ------------------------------------------------
6
+ # SOURCE -----------------------------------------
7
+ # ------------------------------------------------
8
+ source "https://rubygems.org"
9
+
10
+ # ------------------------------------------------
11
+ # RUBY -------------------------------------------
12
+ # ------------------------------------------------
13
+ ruby "2.1.1"
14
+
15
+ # ------------------------------------------------
16
+ # GEMS -------------------------------------------
17
+ # ------------------------------------------------
18
+ gemspec
19
+
data/LICENSE ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ {description}
294
+ Copyright (C) {year} {fullname}
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ {signature of Ty Coon}, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
340
+
data/README.md ADDED
@@ -0,0 +1,107 @@
1
+ # Open For Editing (ofe)
2
+
3
+ CLI Gem which opens specified files (ofe.json) for editing in your text editor
4
+
5
+ **Example:**
6
+
7
+ ```
8
+ # Open the 'default' group in your editor
9
+ # For example, this may execute: vim Gemfile Rakefile README.md app/models/* [...]
10
+ $ ofe
11
+ ```
12
+
13
+ ## Installation
14
+
15
+ ```Shell
16
+ git clone https://github.com/eriknomitch/ofe.git
17
+ cd ofe
18
+ rake
19
+ ```
20
+
21
+ ## Configuration
22
+
23
+ Add an `ofe.json` configuration file in any directory.
24
+
25
+ The primary keys define "groups" which you can pass to `ofe` (see Usage).
26
+
27
+ Within groups, you can define keys:
28
+ * `"extensions":` Recursively searches your entire current directory for files with that extension to edit.
29
+ * `"files":` Either relative paths to files you want to open for editing or paths with globbing.
30
+ * `"exclusions":` Exclude any files starting with the exclusion paths specified.
31
+ * `"first_file":` Ensure that this file path is the first argument to your editor.
32
+ * `"topology":` Defines a topology to topologically sort the found files (i.e., which files should be passed after which other files)
33
+ * `"command":` Executes a shell command and adds all files (delimited by newlines) from its output to the open list. Be careful with this one.
34
+
35
+ **Example ofe.json:**
36
+
37
+ ```Json
38
+ {
39
+ "default": {
40
+ "extensions": [".rb", ".gem", ".md"],
41
+ "files": ["Rakefile", "Gemfile", "bin/*", "ofe.json", ".gitignore"],
42
+ "exclusions": ["test/", "spec/"],
43
+ "first_file": "Gemfile",
44
+ "topology": {"baz.rb": ["foo.rb, "foo.rb"]}
45
+ },
46
+ "docs": {
47
+ "extensions": [".md"]
48
+ },
49
+ "git": {
50
+ "files": [".git/config", ".gitignore"]
51
+ },
52
+ "diff": {
53
+ "command": "git diff --name-only"
54
+ },
55
+ "test": {
56
+ "files": ["test/**/*.rb", "spec/**/*.rb"]
57
+ }
58
+ }
59
+ ```
60
+
61
+ Match all files recursively in a directory and its subdirectories with:
62
+
63
+ ```Json
64
+ {
65
+ "my_group": {
66
+ "files": ["my_directory/**/**"]
67
+ }
68
+ }
69
+ ```
70
+
71
+ Match all files with an extension recursively in a directory and its subdirectories with:
72
+
73
+ ```Json
74
+ {
75
+ "my_group": {
76
+ "files": ["my_directory/**/*.ext"]
77
+ }
78
+ }
79
+ ```
80
+
81
+ ## Usage
82
+
83
+ ```Shell
84
+ # Opens the 'default' group in your editor (e.g., executes: vim Gemfile README.md [...])
85
+ $ ofe
86
+
87
+ # Opens the 'docs' group in your editor
88
+ $ ofe docs
89
+
90
+ # Lists all groups configured in ofe.json
91
+ $ ofe --groups|-g
92
+
93
+ # Parses and pretty prints ofe.json
94
+ $ ofe --list|-l
95
+
96
+ # Parses and pretty prints group from ofe.json
97
+ $ ofe --list|-l git
98
+
99
+ # Writes an example config file to ./ofe.json
100
+ $ ofe --mk-example-config|-m
101
+
102
+ # Opens ofe.json in your editor
103
+ $ ofe --self|-s
104
+ ```
105
+
106
+ ## Credits
107
+ Erik Nomitch: erik@nomitch.com
data/Rakefile ADDED
@@ -0,0 +1,30 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ desc "Tests ofe gem"
5
+
6
+ task :test do
7
+ #sh "rspec spec/ofe_spec.rb"
8
+ end
9
+
10
+ desc "Uninstalls ofe gem and executables"
11
+
12
+ task :uninstall do
13
+ sh "gem uninstall ofe --executables"
14
+ end
15
+
16
+ desc "Builds ofe gem"
17
+
18
+ task :build do
19
+ sh "gem build ofe.gemspec"
20
+ end
21
+
22
+ desc "Installs ofe gem"
23
+
24
+ task :install do
25
+ sh "gem install ofe-0.0.0.gem"
26
+ end
27
+
28
+ desc "Uninstalls, Builds, and Installs ofe gem"
29
+
30
+ task :default => [:uninstall, :build, :install]
data/bin/ofe ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+ # ================================================
3
+ # OFE ============================================
4
+ # ================================================
5
+ begin
6
+ require "ofe"
7
+ rescue LoadError
8
+ require "rubygems"
9
+ require "ofe"
10
+ end
11
+
12
+ Ofe.main
13
+
14
+
data/lib/ofe.rb ADDED
@@ -0,0 +1,312 @@
1
+ # ================================================
2
+ # OFE ============================================
3
+ # ================================================
4
+ require "json"
5
+ require "shellwords"
6
+ require "tsort"
7
+
8
+ require "ofe/t_sorted_files"
9
+
10
+ # ------------------------------------------------
11
+ # MODULE->OFE ------------------------------------
12
+ # ------------------------------------------------
13
+ module Ofe
14
+
15
+ # ----------------------------------------------
16
+ # MODULE->VARIABLES ----------------------------
17
+ # ----------------------------------------------
18
+ @@config_json = nil
19
+
20
+ # ----------------------------------------------
21
+ # UTILITY --------------------------------------
22
+ # ----------------------------------------------
23
+ def self.current_file_basename
24
+ File.basename $0
25
+ end
26
+
27
+ def self.parse_and_execute_special_arguments
28
+ case ARGV.first
29
+ when "--list", "-l"
30
+ list ARGV[1..ARGV.length-1]
31
+ exit
32
+
33
+ when "--groups", "-g"
34
+ list_group_names
35
+ exit
36
+
37
+ when "--mk-example-config", "-m"
38
+ make_example_config_file
39
+ exit
40
+
41
+ when "--self", "-s"
42
+ open_self
43
+ exit
44
+
45
+ end
46
+ end
47
+
48
+ def self.list(argv)
49
+ require_and_parse_config_file
50
+
51
+ # Support and check for "--list <group>"
52
+ if group = argv.first
53
+ to_puts = @@config_json[group]
54
+ raise "Group '#{group}' not found in ofe.json." unless to_puts
55
+
56
+ # <group> was not passed
57
+ else
58
+ to_puts = @@config_json
59
+ end
60
+
61
+ puts JSON.pretty_generate(to_puts)
62
+ end
63
+
64
+ def self.list_group_names
65
+ require_and_parse_config_file
66
+
67
+ puts @@config_json.keys
68
+ end
69
+
70
+ def self.make_example_config_file
71
+ raise "Cannot make config file because ofe.json already exists in this directory." if config_file_exists?
72
+
73
+ empty_config_file = <<-EOS
74
+ {
75
+ "default": {
76
+ "extensions": [],
77
+ "files": ["ofe.json"]
78
+ },
79
+ "docs": {
80
+ "extensions": [".md"]
81
+ },
82
+ "git": {
83
+ "files": [".git/config", ".gitignore"]
84
+ }
85
+ }
86
+ EOS
87
+
88
+ File.open(config_file_filename, "w") do |file|
89
+ file.puts empty_config_file
90
+ end
91
+
92
+ puts "Example ofe.json file:"
93
+ puts "--------------------------------------------------"
94
+ puts empty_config_file
95
+ puts "--------------------------------------------------"
96
+ puts "Wrote example config file to ofe.json"
97
+
98
+ end
99
+
100
+ def self.open_self
101
+ require_config_file
102
+
103
+ system "#{editor} #{config_file_filename}"
104
+ end
105
+
106
+ def self.require_editor_env_variable
107
+ unless ENV["EDITOR"]
108
+ raise "EDITOR environment variable is not set."
109
+ end
110
+ end
111
+
112
+ def self.editor
113
+ ENV["EDITOR"]
114
+ end
115
+
116
+ def self.ensure_group_key_is_class_if_exists(group, group_config, key, compare_class)
117
+ if group_config[key] and group_config[key].class != compare_class
118
+ raise "Config key '#{key}' is not class #{compare_class} for group '#{group}'."
119
+ end
120
+ end
121
+
122
+ def self.file_should_be_excluded?(file, exclusions)
123
+ exclusions.each do |exclusion|
124
+ return true if file.start_with?(exclusion)
125
+ end
126
+ false
127
+ end
128
+
129
+ # ----------------------------------------------
130
+ # CONFIG-FILE ----------------------------------
131
+ # ----------------------------------------------
132
+ def self.config_file_filename
133
+ "ofe.json"
134
+ end
135
+
136
+ def self.config_file_exists?
137
+ File.exist? config_file_filename
138
+ end
139
+
140
+ def self.require_config_file
141
+ return true if config_file_exists?
142
+
143
+ raise "fatal: No ofe.json config file found in this directory."
144
+ end
145
+
146
+ def self.require_and_parse_config_file
147
+ require_config_file
148
+
149
+ begin
150
+
151
+ @@config_json = JSON.parse(File.open(config_file_filename).read)
152
+
153
+ rescue => exception
154
+ raise "Cannot parse ofe.json because its JSON is invalid."
155
+ end
156
+
157
+ end
158
+
159
+ def self.find_group_config(group)
160
+ @@config_json[group.to_s]
161
+ end
162
+
163
+ # ----------------------------------------------
164
+ # GROUP ----------------------------------------
165
+ # ----------------------------------------------
166
+ def self.get_group
167
+ return :default if ARGV.count == 0
168
+
169
+ ARGV.first.to_sym
170
+ end
171
+
172
+ def self.format_files_to_open(files)
173
+ Shellwords.join(files)
174
+ end
175
+
176
+ def self.files_to_open_for_group(group, formatted: false)
177
+ group_config = find_group_config(group)
178
+
179
+ raise "Group '#{group}' is not defined in your ofe.json config file." unless group_config
180
+
181
+ files = group_config["files"]
182
+ extensions = group_config["extensions"]
183
+ exclusions = group_config["exclusions"]
184
+ first_file = group_config["first_file"]
185
+ command = group_config["command"]
186
+ topology = group_config["topology"]
187
+
188
+ to_open = []
189
+
190
+ # Check that at least one definition exists
191
+ raise "Neither files: nor extensions: is defined for group '#{group}'." if !files and !group
192
+
193
+ # Check that they're the right type if they exist
194
+ ["files", "extensions", "exclusions"].each do |key|
195
+ ensure_group_key_is_class_if_exists group, group_config, key, Array
196
+ end
197
+
198
+ ["first_file", "command"].each do |key|
199
+ ensure_group_key_is_class_if_exists group, group_config, key, String
200
+ end
201
+
202
+ ["topology"].each do |key|
203
+ ensure_group_key_is_class_if_exists group, group_config, key, Hash
204
+ end
205
+
206
+ # Add full path/glob files
207
+ # --------------------------------------------
208
+ if files
209
+ files.each do |file|
210
+
211
+ # This will support globbing and make sure the file exists
212
+ to_open.concat Dir[file]
213
+ end
214
+ end
215
+
216
+ # Add files by extension
217
+ # --------------------------------------------
218
+ if extensions
219
+ extensions.each do |extension|
220
+
221
+ # Glob the extension in current directory and all subdirectories
222
+ files_found = Dir["**/*#{extension}"]
223
+ to_open.concat files_found
224
+ end
225
+ end
226
+
227
+ # Add files by command
228
+ # --------------------------------------------
229
+ if command
230
+ to_open.concat(`#{command}`.split("\n"))
231
+ end
232
+
233
+ # Check for exclusions and exclude
234
+ # --------------------------------------------
235
+ if exclusions
236
+ to_open = to_open.collect do |file|
237
+ file unless file_should_be_excluded?(file, exclusions)
238
+ end.compact
239
+ end
240
+
241
+ # Uniqify
242
+ # --------------------------------------------
243
+ to_open.uniq!
244
+
245
+ # Remove any matches that are directories
246
+ # --------------------------------------------
247
+ to_open.delete_if {|file| Dir.exist? file }
248
+
249
+ # Topologically sort files
250
+ # --------------------------------------------
251
+ if topology
252
+ to_open = TSortedFiles.new(to_open, topology).sorted
253
+ end
254
+
255
+ # Move "first_file" to front
256
+ # --------------------------------------------
257
+ if first_file
258
+
259
+ if to_open.member? first_file
260
+
261
+ # Move to beginning of array
262
+ to_open.delete first_file
263
+ to_open.unshift first_file
264
+
265
+ else
266
+ puts "#{current_file_basename}: warning: Specified first file '#{first_file}' is not included in the list of files to open in group '#{group}'."
267
+ end
268
+
269
+ end
270
+
271
+ # Ensure files were found
272
+ # --------------------------------------------
273
+ raise "No files found for group '#{group}'." if to_open.empty?
274
+
275
+ # Return formatted or as-is
276
+ # --------------------------------------------
277
+ return format_files_to_open(to_open) if formatted
278
+
279
+ to_open
280
+ end
281
+
282
+ # ----------------------------------------------
283
+ # OPENING --------------------------------------
284
+ # ----------------------------------------------
285
+ def self.open_group(group=get_group)
286
+ system "#{editor} #{files_to_open_for_group(group, formatted: true)}"
287
+ end
288
+
289
+ # ----------------------------------------------
290
+ # MAIN -----------------------------------------
291
+ # ----------------------------------------------
292
+ def self.main()
293
+
294
+ begin
295
+
296
+ require_editor_env_variable
297
+
298
+ parse_and_execute_special_arguments
299
+ require_and_parse_config_file
300
+
301
+ open_group
302
+
303
+ rescue => exception
304
+
305
+ puts "#{current_file_basename}: fatal: #{exception}"
306
+ exit 1
307
+
308
+ end
309
+ end
310
+
311
+ end
312
+
@@ -0,0 +1,49 @@
1
+ module Ofe
2
+
3
+ # ----------------------------------------------
4
+ # CLASS->T-SORTED-FILES ------------------------
5
+ # ----------------------------------------------
6
+ class TSortedFiles
7
+ include TSort
8
+
9
+ # --------------------------------------------
10
+ # ATTRIBUTES ---------------------------------
11
+ # --------------------------------------------
12
+ attr_accessor :files, :topology
13
+
14
+ # --------------------------------------------
15
+ # INITIALIZE ---------------------------------
16
+ # --------------------------------------------
17
+ def initialize(files, topology={})
18
+ @topology = topology
19
+
20
+ # The topology will most likely only have a few keys/files
21
+ # set so we need to append the rest (as empty arrays).
22
+ #
23
+ # This way we can sort all of them.
24
+ files.each do |file|
25
+ @topology[file] = [] unless @topology[file]
26
+ end
27
+ end
28
+
29
+ # --------------------------------------------
30
+ # TSORT --------------------------------------
31
+ # --------------------------------------------
32
+ def tsort_each(&block)
33
+ @topology.each(&block)
34
+ end
35
+
36
+ def tsort_each_node(&block)
37
+ @topology.each_key(&block)
38
+ end
39
+
40
+ def tsort_each_child(node, &block)
41
+ @topology[node].each(&block)
42
+ end
43
+
44
+ def sorted
45
+ tsort
46
+ end
47
+
48
+ end
49
+ end
data/ofe.gemspec ADDED
@@ -0,0 +1,69 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+ # stub: ofe 0.1.0 ruby lib
6
+
7
+ Gem::Specification.new do |s|
8
+ s.name = "ofe"
9
+ s.version = "0.1.0"
10
+
11
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
12
+ s.require_paths = ["lib"]
13
+ s.authors = ["Erik Nomitch"]
14
+ s.date = "2014-09-27"
15
+ s.description = "Open For Editing: CLI Gem which opens specified files (ofe.json) for editing in your text editor."
16
+ s.email = "erik@nomitch.com"
17
+ s.executables = ["ofe"]
18
+ s.extra_rdoc_files = [
19
+ "LICENSE",
20
+ "README.md"
21
+ ]
22
+ s.files = [
23
+ "Gemfile",
24
+ "LICENSE",
25
+ "README.md",
26
+ "Rakefile",
27
+ "bin/ofe",
28
+ "lib/ofe.rb",
29
+ "lib/ofe/t_sorted_files.rb",
30
+ "ofe.gemspec",
31
+ "ofe.json"
32
+ ]
33
+ s.homepage = "https://github.com/eriknomitch/ofe"
34
+ s.licenses = ["GPL-2"]
35
+ s.post_install_message = "---------------------------------------------------------------\nIf you have not done so, you will need to set your EDITOR \nenvironment variable (usually in ~/.bashrc or ~/.zshrc).\n\nExample:\n\nexport EDITOR=vim\n---------------------------------------------------------------\n"
36
+ s.rubygems_version = "2.4.6"
37
+ s.summary = "Open For Editing"
38
+
39
+ if s.respond_to? :specification_version then
40
+ s.specification_version = 4
41
+
42
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
43
+ s.add_development_dependency(%q<shoulda>, [">= 0"])
44
+ s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
45
+ s.add_development_dependency(%q<yard>, ["~> 0.7"])
46
+ s.add_development_dependency(%q<bundler>, ["~> 1.0"])
47
+ s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
48
+ s.add_development_dependency(%q<simplecov>, [">= 0"])
49
+ s.add_development_dependency(%q<pry>, [">= 0"])
50
+ else
51
+ s.add_dependency(%q<shoulda>, [">= 0"])
52
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
53
+ s.add_dependency(%q<yard>, ["~> 0.7"])
54
+ s.add_dependency(%q<bundler>, ["~> 1.0"])
55
+ s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
56
+ s.add_dependency(%q<simplecov>, [">= 0"])
57
+ s.add_dependency(%q<pry>, [">= 0"])
58
+ end
59
+ else
60
+ s.add_dependency(%q<shoulda>, [">= 0"])
61
+ s.add_dependency(%q<rdoc>, ["~> 3.12"])
62
+ s.add_dependency(%q<yard>, ["~> 0.7"])
63
+ s.add_dependency(%q<bundler>, ["~> 1.0"])
64
+ s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
65
+ s.add_dependency(%q<simplecov>, [">= 0"])
66
+ s.add_dependency(%q<pry>, [">= 0"])
67
+ end
68
+ end
69
+
data/ofe.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "default": {
3
+ "extensions": [".rb", ".gem", "*.gemspec", ".md"],
4
+ "files": ["Rakefile", "Gemfile", "bin/*", "ofe.json", ".gitignore", "foo bar"],
5
+ "first_file": "Gemfile"
6
+ },
7
+ "docs": {
8
+ "extensions": [".md"]
9
+ },
10
+ "diff": {
11
+ "command": "git diff --name-only"
12
+ },
13
+ "git": {
14
+ "files": [".git/config", ".gitignore"]
15
+ }
16
+ }
metadata ADDED
@@ -0,0 +1,156 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ofe
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Erik Nomitch
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-09-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: shoulda
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rdoc
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '3.12'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '3.12'
41
+ - !ruby/object:Gem::Dependency
42
+ name: yard
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0.7'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '0.7'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bundler
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: jeweler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 2.0.1
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 2.0.1
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: pry
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: 'Open For Editing: CLI Gem which opens specified files (ofe.json) for
112
+ editing in your text editor.'
113
+ email: erik@nomitch.com
114
+ executables:
115
+ - ofe
116
+ extensions: []
117
+ extra_rdoc_files:
118
+ - LICENSE
119
+ - README.md
120
+ files:
121
+ - Gemfile
122
+ - LICENSE
123
+ - README.md
124
+ - Rakefile
125
+ - bin/ofe
126
+ - lib/ofe.rb
127
+ - lib/ofe/t_sorted_files.rb
128
+ - ofe.gemspec
129
+ - ofe.json
130
+ homepage: https://github.com/eriknomitch/ofe
131
+ licenses:
132
+ - GPL-2
133
+ metadata: {}
134
+ post_install_message: "---------------------------------------------------------------\nIf
135
+ you have not done so, you will need to set your EDITOR \nenvironment variable (usually
136
+ in ~/.bashrc or ~/.zshrc).\n\nExample:\n\nexport EDITOR=vim\n---------------------------------------------------------------\n"
137
+ rdoc_options: []
138
+ require_paths:
139
+ - lib
140
+ required_ruby_version: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - ">="
143
+ - !ruby/object:Gem::Version
144
+ version: '0'
145
+ required_rubygems_version: !ruby/object:Gem::Requirement
146
+ requirements:
147
+ - - ">="
148
+ - !ruby/object:Gem::Version
149
+ version: '0'
150
+ requirements: []
151
+ rubyforge_project:
152
+ rubygems_version: 2.4.6
153
+ signing_key:
154
+ specification_version: 4
155
+ summary: Open For Editing
156
+ test_files: []