command_mapper-gen 0.1.0.pre1

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'command_mapper/gen/version'
+include CommandMapper::Gen
+
+require 'simplecov'
+SimpleCov.start

data/spec/task_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'command_mapper/gen/task'
+
+describe CommandMapper::Gen::Task do
+  let(:command_name) { 'grep' }
+  let(:output) { '/path/to/output.rb' }
+
+  subject { described_class.new(command_name,output) }
+
+  describe "#initialize" do
+    it "must set #command_name" do
+      expect(subject.command_name).to eq(command_name)
+    end
+
+    it "must set #output" do
+      expect(subject.output).to eq(output)
+    end
+
+    context "when the parser: keyword argument is given" do
+      let(:parser) { :man }
+
+      subject { described_class.new(command_name,output, parser: parser) }
+
+      it "must set #parser" do
+        expect(subject.parser).to eq(parser)
+      end
+    end
+
+    context "when a block is given" do
+      it "must yield the new task and then call #define" do
+        yielded_task = nil
+
+        described_class.new(command_name,output) do |task|
+          yielded_task = task
+
+          expect(task).to receive(:define)
+        end
+
+        expect(yielded_task).to be_kind_of(described_class)
+      end
+    end
+  end
+
+  describe "#generate" do
+    it "must call `sh('command_mapper-gen','--output',output,command_name)`" do
+      expect(subject).to receive(:sh).with(
+        'command_mapper-gen', '--output', output, command_name
+      )
+
+      subject.generate
+    end
+
+    context "when #parser is set" do
+      let(:parser) { :man }
+
+      subject { described_class.new(command_name,output, parser: parser) }
+
+      it "must call `sh('command_mapper-gen','--output',output,'--parser',parser,command_name)`" do
+        expect(subject).to receive(:sh).with(
+          'command_mapper-gen', '--output', output,
+                                '--parser', parser.to_s,
+                                command_name
+        )
+
+        subject.generate
+      end
+    end
+  end
+end

data/spec/types/enum_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'command_mapper/gen/types/enum'
+
+describe CommandMapper::Gen::Types::Enum do
+  let(:values) do
+    [:foo, :bar, :baz]
+  end
+
+  subject { described_class.new(values) }
+
+  describe "#initialize" do
+    it "must set #values" do
+      expect(subject.values).to eq(values)
+    end
+  end
+
+  describe "#to_ruby" do
+    context "when #map only has one value" do
+      let(:value) { :foo }
+      let(:values) do
+        [value]
+      end
+
+      it "must return 'Enum[value]'" do
+        expect(subject.to_ruby).to eq(
+          "Enum[#{value.inspect}]"
+        )
+      end
+    end
+
+    context "when #map has more than one key:value pair" do
+      let(:value1) { "foo" }
+      let(:value2) { "bar" }
+      let(:values) do
+        [value1, value2]
+      end
+
+      it "must return 'Enum[value, ...]'" do
+        expect(subject.to_ruby).to eq(
+          "Enum[#{value1.inspect}, #{value2.inspect}]"
+        )
+      end
+    end
+  end
+end

data/spec/types/key_value_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'command_mapper/gen/types/key_value'
+
+describe CommandMapper::Gen::Types::KeyValue do
+  describe "#initialize" do
+    it "must default #separator to '='" do
+      expect(subject.separator).to eq('=')
+    end
+
+    context "when initialized with the separator: keyword argument" do
+      let(:separator) { ':' }
+
+      subject { described_class.new(separator: separator) }
+
+      it "must set #separator" do
+        expect(subject.separator).to eq(separator)
+      end
+    end
+  end
+
+  describe "#to_ruby" do
+    it "must return 'KeyValue.new()'" do
+      expect(subject.to_ruby).to eq("KeyValue.new()")
+    end
+
+    context "when #separator is not '='" do
+      let(:separator) { ':' }
+
+      subject { described_class.new(separator: separator) }
+
+      it "must return 'KeyValue.new(separator: ...)'" do
+        expect(subject.to_ruby).to eq("KeyValue.new(separator: #{separator.inspect})")
+      end
+    end
+  end
+end

data/spec/types/list_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'command_mapper/gen/types/list'
+
+describe CommandMapper::Gen::Types::List do
+  describe "#initialize" do
+    it "must default #separator to ','" do
+      expect(subject.separator).to eq(',')
+    end
+
+    context "when initialized with the separator: keyword argument" do
+      let(:separator) { ';' }
+
+      subject { described_class.new(separator: separator) }
+
+      it "must set #separator" do
+        expect(subject.separator).to eq(separator)
+      end
+    end
+  end
+
+  describe "#to_ruby" do
+    it "must return 'List.new()'" do
+      expect(subject.to_ruby).to eq("List.new()")
+    end
+
+    context "when #separator is not ','" do
+      let(:separator) { ';' }
+
+      subject { described_class.new(separator: separator) }
+
+      it "must return 'List.new(separator: ...)'" do
+        expect(subject.to_ruby).to eq("List.new(separator: #{separator.inspect})")
+      end
+    end
+  end
+end

data/spec/types/map_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'command_mapper/gen/types/map'
+
+describe CommandMapper::Gen::Types::Map do
+  let(:map) do
+    {:foo => "foo", :bar => "bar"}
+  end
+
+  subject { described_class.new(map) }
+
+  describe "#initialize" do
+    it "must set #map" do
+      expect(subject.map).to eq(map)
+    end
+  end
+
+  describe "#to_ruby" do
+    context "when #map only has one key:value pair" do
+      let(:key)   { :foo }
+      let(:value) { "foo" }
+      let(:map) do
+        {key => value}
+      end
+
+      it "must return 'Map.new(key => value)'" do
+        expect(subject.to_ruby).to eq(
+          "Map.new(#{key.inspect} => #{value.inspect})"
+        )
+      end
+    end
+
+    context "when #map has more than one key:value pair" do
+      let(:key1)   { :foo }
+      let(:value1) { "foo" }
+      let(:key2)   { :bar }
+      let(:value2) { "bar" }
+      let(:map) do
+        {key1 => value1, key2 => value2}
+      end
+
+      it "must return 'Map.new(key => value, ...)'" do
+        expect(subject.to_ruby).to eq(
+          "Map.new(#{key1.inspect} => #{value1.inspect}, #{key2.inspect} => #{value2.inspect})"
+        )
+      end
+    end
+  end
+end

data/spec/types/str_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'command_mapper/gen/types/str'
+
+describe CommandMapper::Gen::Types::Str do
+  describe "#initialize" do
+    it "must default #allow_empty to nil" do
+      expect(subject.allow_empty).to be(nil)
+    end
+
+    it "must default #allow_blank to nil" do
+      expect(subject.allow_blank).to be(nil)
+    end
+
+    context "when the allow_empty: keyword is given" do
+      let(:allow_empty) { true }
+
+      subject { described_class.new(allow_empty: allow_empty) }
+
+      it "must set #allow_empty" do
+        expect(subject.allow_empty).to be(allow_empty)
+      end
+    end
+
+    context "when the allow_blank: keyword is given" do
+      let(:allow_blank) { true }
+
+      subject { described_class.new(allow_blank: allow_blank) }
+
+      it "must set #allow_blank" do
+        expect(subject.allow_blank).to be(allow_blank)
+      end
+    end
+  end
+
+  describe "#to_ruby" do
+    context "when none of the keywords are set" do
+      subject { described_class.new }
+
+      it "must return nil" do
+        expect(subject.to_ruby).to be(nil)
+      end
+    end
+
+    context "when only one keyword is set" do
+      let(:keyword) { :allow_empty }
+      let(:value)   { true }
+
+      subject { described_class.new(**{keyword => value}) }
+
+      it "must return only that one keyword and it's value" do
+        expect(subject.to_ruby).to eq("#{keyword}: #{value.inspect}")
+      end
+    end
+
+    context "when more than one keyword is set" do
+      let(:allow_empty) { true }
+      let(:allow_blank) { true }
+
+      subject do
+        described_class.new(allow_empty: allow_empty, allow_blank: allow_blank)
+      end
+
+      it "must return the set keyword and their values" do
+        expect(subject.to_ruby).to eq(
+          "allow_empty: #{allow_empty.inspect}, allow_blank: #{allow_blank.inspect}"
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: command_mapper-gen
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre1
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: command_mapper-gen parses a command's --help output and man-page, then
+  generates the command_mapper Ruby class for the command.
+email: postmodern.mod3@gmail.com
+executables:
+- command_mapper-gen
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/command_mapper-gen
+- commnad_mapper-gen.gemspec
+- examples/grep.rb
+- gemspec.yml
+- lib/command_mapper/gen.rb
+- lib/command_mapper/gen/arg.rb
+- lib/command_mapper/gen/argument.rb
+- lib/command_mapper/gen/cli.rb
+- lib/command_mapper/gen/command.rb
+- lib/command_mapper/gen/exceptions.rb
+- lib/command_mapper/gen/option.rb
+- lib/command_mapper/gen/option_value.rb
+- lib/command_mapper/gen/parsers.rb
+- lib/command_mapper/gen/parsers/common.rb
+- lib/command_mapper/gen/parsers/help.rb
+- lib/command_mapper/gen/parsers/man.rb
+- lib/command_mapper/gen/parsers/options.rb
+- lib/command_mapper/gen/parsers/usage.rb
+- lib/command_mapper/gen/task.rb
+- lib/command_mapper/gen/types.rb
+- lib/command_mapper/gen/types/enum.rb
+- lib/command_mapper/gen/types/key_value.rb
+- lib/command_mapper/gen/types/list.rb
+- lib/command_mapper/gen/types/map.rb
+- lib/command_mapper/gen/types/num.rb
+- lib/command_mapper/gen/types/str.rb
+- lib/command_mapper/gen/version.rb
+- spec/argument_spec.rb
+- spec/cli_spec.rb
+- spec/command_spec.rb
+- spec/option_spec.rb
+- spec/option_value_spec.rb
+- spec/parsers/common_spec.rb
+- spec/parsers/help_spec.rb
+- spec/parsers/man_spec.rb
+- spec/parsers/options_spec.rb
+- spec/parsers/usage_spec.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
+- spec/types/enum_spec.rb
+- spec/types/key_value_spec.rb
+- spec/types/list_spec.rb
+- spec/types/map_spec.rb
+- spec/types/str_spec.rb
+homepage: https://github.com/postmodern/command_mapper-gen.rb#readme
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/command_mapper-gen
+  source_code_uri: https://github.com/postmodern/command_mapper-gen.rb
+  bug_tracker_uri: https://github.com/postmodern/command_mapper-gen.rb/issues
+  changelog_uri: https://github.com/postmodern/command_mapper-gen.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Generates command_mapper Ruby classes for a given command
+test_files: []