cri 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa633b78bf3bb39d2ddc9c5abc1ce94f27dd57bb1d130336acc58c1ae83ffcf
-  data.tar.gz: 2cc7102d387382bdfe15a0ccdb080d92c989f77716d217c0899a3ec688090886
+  metadata.gz: e4990c5f7f5168cb66f3e434512976721a3dc2b1e93b0a88306c58106aacb21c
+  data.tar.gz: 6866a5179a3c338c905e5d50cb89391b12608e7d0d246def19a3e0e5971fa6f8
 SHA512:
-  metadata.gz: 82e32293ba6c802449eeb1731742250bb5f5503cfdd1d05d8fd2e1b113ee3704e39a684cf9d87adf02c26becb95209bb34f32bc749e09017fb31b10dc5abde72
-  data.tar.gz: 5a51c230c68d3a4612eaae905605448997133418b12a703a1b154ac6c39a7e67e94305bbd680edfd6332b8fa806d9e3b94eb7d7c54529b0bc868f081f295d246
+  metadata.gz: cd21b56d57ce4356a19a4875ada15f13c7019f739ea7267a104610c3ad33557dff506c589e4b70929d20d77a938d2fb71e963ca5b2a908ad54a7ac6e89dea4e1
+  data.tar.gz: b7dfaf7409934b132cc640ca21a0128af76ea1835986627ea68d83922233fe6b14b8e8a296143ed6d545beb7c408ea028cc8353aca8d2b4371171d5c01ba02cb

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    cri (2.13.0)
+      colored (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    asciidoctor (1.5.7.1)
+    ast (2.4.0)
+    colored (1.2)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    docile (1.3.1)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+    unicode-display_width (1.4.0)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asciidoctor
+  bundler (~> 1.6)
+  coveralls
+  cri!
+  minitest
+  rake
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.16.4

data/NEWS.md

@@ -1,5 +1,10 @@
-Cri News
-========
+# Cri News
+
+## 2.14.0
+
+Features:
+
+* Added `Cri::Command.load_file`
 
 ## 2.13.0
 

data/README.md

@@ -343,6 +343,64 @@ command has subcommands, and no subcommands are otherwise explicitly specified:
 default_subcommand 'compile'
 ```
 
+### Loading commands from separate files
+
+You can use `Cri::Command.load_file` to load a command from a file.
+
+For example, given the file _commands/check.rb_ with the following contents:
+
+```ruby
+name        'check'
+usage       'check'
+summary     'runs all checks'
+description '…'
+
+run do |opts, args, cmd|
+  puts "Running checks…"
+end
+```
+
+To load this command:
+
+```ruby
+Cri::Command.load_file('commands/check.rb')
+```
+
+`Cri::Command.load_file` expects the file to be in UTF-8.
+
+You can also use it to load subcommands:
+
+```ruby
+root_cmd = Cri::Command.load_file('commands/nanoc.rb')
+root_cmd.add_command(Cri::Command.load_file('commands/comile.rb'))
+root_cmd.add_command(Cri::Command.load_file('commands/view.rb'))
+root_cmd.add_command(Cri::Command.load_file('commands/check.rb'))
+```
+
+#### Automatically inferring command names
+
+Pass `infer_name: true` to `Cri::Command.load_file` to use the file basename as the name of the command.
+
+For example, given a file _commands/check.rb_ with the following contents:
+
+```ruby
+usage       'check'
+summary     'runs all checks'
+description '…'
+
+run do |opts, args, cmd|
+  puts "Running checks…"
+end
+```
+
+To load this command and infer the name:
+
+```ruby
+cmd = Cri::Command.load_file('commands/check.rb', infer_name: true)
+```
+
+`cmd.name` will be `check`, derived from the filename.
+
 ## Contributors
 
 * Bart Mesuere

data/lib/cri/command.rb

@@ -132,6 +132,22 @@ module Cri
       dsl.command
     end
 
+    # Creates a new command using a DSL, from code defined in the given filename.
+    #
+    # @param [String] filename The filename that contains the command definition
+    #   as a string
+    #
+    # @return [Cri::Command] The newly defined command
+    def self.load_file(filename, infer_name: false)
+      code = File.read(filename, encoding: 'UTF-8')
+      define(code, filename).tap do |cmd|
+        if infer_name
+          command_name = File.basename(filename, '.rb')
+          cmd.modify { name command_name }
+        end
+      end
+    end
+
     # Returns a new command that has support for the `-h`/`--help` option and
     # also has a `help` subcommand. It is intended to be modified (adding
     # name, summary, description, other subcommands, …)

data/lib/cri/version.rb

@@ -2,5 +2,5 @@
 
 module Cri
   # The current Cri version.
-  VERSION = '2.13.0'
+  VERSION = '2.14.0'
 end

data/test/test_command.rb

@@ -756,5 +756,79 @@ module Cri
       assert_equal [], lines(out)
       assert_equal ['moo: incorrect number of arguments given: expected 0, but got 1'], lines(err)
     end
+
+    def test_load_file
+      Dir.mktmpdir('foo') do |dir|
+        filename = "#{dir}/moo.rb"
+        File.write(filename, <<~CMD)
+          name        'moo'
+          usage       'dunno whatever'
+          summary     'does stuff'
+          description 'This command does a lot of stuff.'
+          no_params
+
+          run do |_opts, args|
+          end
+        CMD
+
+        cmd = Cri::Command.load_file(filename)
+        assert_equal('moo', cmd.name)
+      end
+    end
+
+    def test_load_file_infer_name_false
+      Dir.mktmpdir('foo') do |dir|
+        filename = "#{dir}/moo.rb"
+        File.write(filename, <<~CMD)
+          usage       'dunno whatever'
+          summary     'does stuff'
+          description 'This command does a lot of stuff.'
+          no_params
+
+          run do |_opts, args|
+          end
+        CMD
+
+        cmd = Cri::Command.load_file(filename)
+        assert_equal(nil, cmd.name)
+      end
+    end
+
+    def test_load_file_infer_name
+      Dir.mktmpdir('foo') do |dir|
+        filename = "#{dir}/moo.rb"
+        File.write(filename, <<~CMD)
+          usage       'dunno whatever'
+          summary     'does stuff'
+          description 'This command does a lot of stuff.'
+          no_params
+
+          run do |_opts, args|
+          end
+        CMD
+
+        cmd = Cri::Command.load_file(filename, infer_name: true)
+        assert_equal('moo', cmd.name)
+      end
+    end
+
+    def test_load_file_infer_name_double
+      Dir.mktmpdir('foo') do |dir|
+        filename = "#{dir}/moo.rb"
+        File.write(filename, <<~CMD)
+          name        'oink'
+          usage       'dunno whatever'
+          summary     'does stuff'
+          description 'This command does a lot of stuff.'
+          no_params
+
+          run do |_opts, args|
+          end
+        CMD
+
+        cmd = Cri::Command.load_file(filename, infer_name: true)
+        assert_equal('moo', cmd.name)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -50,6 +50,7 @@ extra_rdoc_files:
 files:
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - NEWS.md
 - README.md