hss 0.2.4 → 0.2.5

data/lib/version.rb

@@ -0,0 +1,6 @@
+##
+# Define the version
+
+module HSS
+  VERSION = '0.2.5'
+end

data/spec/helpers/command_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe HSS::Parser do
+  let(:config) { 'spec/test/config.yml' }
+  let(:handler) { HSS::Handler.new config }
+
+  describe '#command' do
+    it 'runs shell commands' do
+      expect(handler.handle 'cmd_bar').to eql 'bar@example.org'
+    end
+    context 'if the command is invalid' do
+      it 'raises an error' do
+        expect { handler.handle 'failcmd_zsxdcf' }.to raise_error RuntimeError
+      end
+    end
+    context 'if the command is not executable' do
+      it 'raises an error' do
+        expect { handler.handle 'failcmd_LICENSE' }.to raise_error RuntimeError
+      end
+    end
+    context 'if the command fails' do
+      it 'raises an error' do
+        expect { handler.handle 'failcmd_false' }.to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/helpers/default_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe HSS::Parser do
+  let(:config) { 'spec/test/config.yml' }
+  let(:handler) { HSS::Handler.new config }
+
+  describe '#default' do
+    it 'uses the provided value if set' do
+      expect(handler.handle 'def_77').to eql 'chose_77'
+    end
+    it 'uses the default if the value is unset' do
+      expect(handler.handle 'def_').to eql 'chose_10'
+    end
+  end
+end

data/spec/helpers/expand_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe HSS::Parser do
+  let(:config) { 'spec/test/config.yml' }
+  let(:handler) { HSS::Handler.new config }
+
+  describe '#expand' do
+    it 'matches keywords in a mapping' do
+      expect(handler.handle 'exp_a').to eql 'exp_alpha'
+      expect(handler.handle 'exp_2').to eql 'exp_beta'
+    end
+    context 'when no match is found' do
+      it 'raises an error' do
+        expect { handler.handle 'exp_c' }.to raise_error NameError
+      end
+    end
+  end
+end

data/spec/helpers/external_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe HSS::Parser do
+  let(:config) { 'spec/test/config.yml' }
+  let(:handler) { HSS::Handler.new config }
+
+  describe '#external' do
+    it 'reads values from a YAML file' do
+      expect(handler.handle 'ext_test.first.color').to eql 'external_blue'
+    end
+    context 'when a key is not found' do
+      it 'raises an error' do
+        expect { handler.handle 'ext_test.three' }.to raise_error NameError
+        expect { handler.handle 'ext_test.five.tree' }.to raise_error NameError
+      end
+    end
+    context 'when the source does not exist' do
+      it 'raises an error' do
+        expect { handler.handle 'failext_abcd' }.to raise_error RuntimeError
+      end
+    end
+    context 'when the source YAML is invalid' do
+      it 'raises an error' do
+        expect { handler.handle 'failext_invalid' }.to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/helpers/shortcut_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe HSS::Parser do
+  let(:config) { 'spec/test/config.yml' }
+  let(:handler) { HSS::Handler.new config }
+
+  describe '#shortcut' do
+    it 'expands shortcut text' do
+      expect(handler.handle 'short_a').to eql 'short_ALPHA'
+      expect(handler.handle 'short_b').to eql 'short_BETA'
+    end
+    context 'when an invalid shortcut is used' do
+      it 'raises an error' do
+        expect { handler.handle 'short_z' }.to raise_error NameError
+      end
+    end
+  end
+end

data/spec/hss_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe HSS do
+  let(:config) { 'spec/test/config.yml' }
+  let(:handler) { HSS::Handler.new config }
+
+  describe '::VERSION' do
+    it 'follows the semantic version scheme' do
+      expect(HSS::VERSION).to match /\d+\.\d+\.\d+/
+    end
+  end
+
+  describe '#initialize' do
+    it 'creates Handler objects' do
+      expect(HSS.new(config: config)).to be_an_instance_of HSS::Handler
+    end
+  end
+
+  describe HSS::Handler do
+    describe '#initialize' do
+      it 'creates Handler objects' do
+        expect(handler).to be_an_instance_of HSS::Handler
+      end
+    end
+
+    describe '#load_config' do
+      let(:invalid) { 'spec/test/invalid.yml' }
+      let(:incomplete) { 'spec/test/incomplete.yml' }
+
+      it 'loads the specified YAML file' do
+        expect(handler.config).to be_an_instance_of Hash
+        expect(handler.patterns).to be_an_instance_of Array
+      end
+      it 'raises an error for invalid configs' do
+        expect { HSS::Handler.new invalid }.to raise_error RuntimeError
+      end
+      it 'raises an error for configs without patterns' do
+        expect { HSS::Handler.new incomplete }.to raise_error RuntimeError
+      end
+      it 'raises an error if the config does not exist' do
+        expect { HSS::Handler.new 'foobaz' }.to raise_error RuntimeError
+      end
+      it 'uses the default config if none is provided' do
+        if File.exists? File.expand_path(HSS::DEFAULT_CONFIG)
+          expect(HSS::Handler.new.config).to be_an_instance_of Hash
+        else
+          expect { HSS::Handler.new }.to raise_error RuntimeError
+        end
+      end
+    end
+
+    describe '#load_helpers' do
+      it 'loads helper modules' do
+        expect(handler.helpers).to be_an_instance_of Array
+        expect(handler.helpers).to have_at_least(3).items
+      end
+      it 'accepts a helper_path' do
+        h = HSS::Handler.new(config: config, helpers: 'spec/test/good_helpers')
+        expect(h.helpers).to be_an_instance_of Array
+        expect(h.helpers.size).to eql 2
+      end
+      it 'raises LoadError if loading modules fails' do
+        options = { config: config, helpers: 'spec/test/bad_helpers' }
+        expect { HSS::Handler.new options }.to raise_error LoadError
+      end
+    end
+
+    describe '#handle' do
+      it 'matches input to patterns' do
+        expect(handler.handle 'g').to eql 'git@github.com'
+      end
+      it 'supports regex capturing' do
+        expect(handler.handle 'cap99').to eql 'server99.example.org'
+      end
+      it 'supports named captures' do
+        expect(handler.handle 'name_a').to eql 'name_ALPHA'
+      end
+      it 'raises an error if no match is found' do
+        expect { handler.handle 'x' }.to raise_exception RuntimeError
+      end
+      it 'supports combination of helpers' do
+        expect(handler.handle 'bar__1_b').to eql 'bar_9_alpha_BETA'
+      end
+      it 'supports shallow nested operations' do
+        expect(handler.handle 'nest_a').to eql 'winner'
+      end
+      it 'supports deep nested operations' do
+
+      end
+    end
+  end
+
+  describe HSS::Parser do
+    let(:parser) { HSS::Parser.new(key: 'value') }
+
+    describe '#initialize' do
+      it 'creates a Parser' do
+        expect(parser).to be_an_instance_of HSS::Parser
+      end
+      it 'stores the config for later use' do
+        expect(parser.parse('#{@config[:key]}')).to eql 'value'
+      end
+    end
+
+    describe '#check' do
+      it 'compares an input to a short form' do
+        expect(parser.check('a', '[a-z]')).to be_true
+        expect(parser.check('1', '[a-z]')).to be_false
+      end
+    end
+
+    describe '#parse' do
+      it 'evaluates a long_form using the stored scope' do
+        expect(parser.parse('#{$1}')).to eql ''
+        parser.check('winner', '([a-z]+)')
+        expect(parser.parse('#{$1}')).to eql 'winner'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'hss'

data/spec/test/bad_helpers/module.rb

@@ -0,0 +1,2 @@
+# rubocop:disable all
+module

data/spec/test/config.yml

@@ -0,0 +1,73 @@
+---
+patterns:
+  - note: Basic test
+    example: g -> github
+    short: '^g$'
+    long: 'git@github.com'
+  - note: Capture test
+    example: cap1 -> server1.example.org
+    short: '^cap(\d+)$'
+    long: 'server#{$1}.example.org'
+  - note: Named capture test
+    example: name_a -> ALPHA
+    short: '^name_(?<var>\w+)$'
+    long: 'name_#{shortcut(x["var"])}'
+  - note: Command test
+    example: cmdfoo -> "foo"
+    short: '^cmd_([a-z]+)$'
+    long: '#{command("echo " + $1)}@example.org'
+  - note: Command failure test
+    example: failcmd_foobar -> Error
+    short: '^failcmd_([a-zA-Z]+)$'
+    long: '#{command($1)}'
+  - note: Default test
+    example: def -> chose_10
+    short: '^def_(\d*)$'
+    long: 'chose_#{default($1, "10")}'
+  - note: Expansion test
+    example: expa -> exp_alpha
+    short: '^exp_(\w+)'
+    long: 'exp_#{expand($1)}'
+  - note: External test
+    example: ext_test.first.color -> external_red
+    short: '^ext_([a-z.]+)$'
+    long: 'external_#{external("spec/test/external_test.yml", $1)}'
+  - note: External failure test
+    example: failext_foo -> Error
+    short: '^failext_([a-z]+)$'
+    long: 'external_#{external("spec/test/" + $1 + ".yml", "tree.frog")}'
+  - note: Shortcut test
+    example: short_a -> short_ALPHA
+    short: '^short_([a-z])$'
+    long: 'short_#{shortcut($1)}'
+  - note: Mixed test
+    example: bar__1_b -> bar_9_alpha_BETA
+    short: '([^_]+)_([^_]*)_([^_]+)_([^_]+)'
+    long: '#{command("echo " + $1)}_#{default($2, "9")}_#{expand($3)}_#{shortcut($4)}'
+  - note: Shallow nested test
+    example: nest_a -> winner
+    short: '^nest_([a-z])$'
+    long: '#{shortcut(expand($1))}'
+  - note: Deep nested test
+    example: deep_cat_c -> CHARLIE
+    short: '^deep_(?<pet>[a-z]+)_([a-z]+)$'
+    long: '#{expand(x["pet"])}'
+expansions:
+  alpha:
+    - a
+    - '1'
+    - alph
+  beta:
+    - b
+    - '2'
+    - bet
+  '#{shortcut($2)':
+    - fish
+    - dog
+    - cat
+shortcuts:
+    a: ALPHA
+    b: BETA
+    c: CHARLIE
+    alpha: winner
+...

data/spec/test/external_test.yml

@@ -0,0 +1,7 @@
+---
+test:
+  first:
+    color: blue
+  second:
+    animal: monkey
+...

data/spec/test/good_helpers/default.rb

@@ -0,0 +1,8 @@
+##
+# Provides a helper to have default values
+
+class HSS::Parser
+  def default(a, b)
+    a.nil? || a.empty? ? b : a
+  end
+end

data/spec/test/good_helpers/shortcut.rb

@@ -0,0 +1,8 @@
+##
+# Allow shortcut expansion from the config
+
+class HSS::Parser
+  def shortcut(input)
+    @config['shortcuts'][input]
+  end
+end

data/spec/test/incomplete.yml

@@ -0,0 +1,6 @@
+---
+expansions:
+  - some
+  - stuff
+  - here
+...

data/spec/test/invalid.yml

@@ -0,0 +1,8 @@
+---
+patterns:
+  - note: Invalid config
+    example: crash
+    short: '^fish$'
+    long: 'internet'
+such: config: very: wow
+...