raph 0.0.1 → 0.0.2

data/lib/raph/parser/base_parser.rb

@@ -1,47 +1,50 @@
-module Raph
-  # This module consists of argument parsers for Humans
-  module Parser
-    # Base class for all argument parsers.
-    #
-    # You can create a custom parser by subclassing
-    # `Raph::Parser::BaseParser` and overriding some methods,
-    # or by implementing all the methods by duck typing.
-    class BaseParser
-      # Parser unique id.
-      # If parser class name follows a convention NameParser
-      # then it's id will be automatically determined as it's
-      # name in snake case plus suffix 's'
-      #
-      # Example:
-      #    FlagParser.new.id                  # => :flags
-      #    FileParser.new.id                  # => :files
-      #    BaseArgumentParser.new.id          # => :base_arguments
-      def id
-        name = class_name.gsub(/parser$/i, '')
-        name << 's' # make it plural
-        to_underscore(name).to_sym
-      end
-
-      # Parses arguments and returns results of parsing.
-      def parse(args)
-      end
-
-      private
-
-      # Returns name of current class.
-      def class_name
-        self.class.name.split('::').last || ''
-      end
-
-      # Returns underscored version of string
-      # (snake case format).
-      def to_underscore(str)
-       str.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
-      end
-    end
-  end
-end
+module Raph
+  # This module consists of argument parsers for Humans
+  module Parser
+    # Base class for all argument parsers.
+    #
+    # You can create a custom parser by subclassing
+    # `Raph::Parser::BaseParser` and overriding some methods,
+    # or by implementing all the methods by duck typing.
+    class BaseParser
+      # Parser unique id.
+      # If parser class name follows a convention NameParser
+      # then it's id will be automatically determined as it's
+      # name in snake case plus suffix 's'
+      #
+      # Example:
+      #    FlagParser.new.id                  # => :flags
+      #    FileParser.new.id                  # => :files
+      #    BaseArgumentParser.new.id          # => :base_arguments
+      def id
+        name = class_name.gsub(/parser$/i, '')
+        name << 's' # make it plural
+        to_underscored_sym(name)
+      end
+
+      # Parses arguments and returns results of parsing.
+      def parse(args)
+      end
+
+      protected
+
+      # Returns underscored symbol of string
+      # (snake case format).
+      def to_underscored_sym(str)
+        str.gsub(/^[-]+/, '').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase.
+          to_sym
+      end
+
+      private
+
+      # Returns name of current class.
+      def class_name
+        self.class.name.split('::').last || ''
+      end
+    end
+  end
+end

data/lib/raph/parser/file_parser.rb

@@ -1,24 +1,24 @@
-require 'raph/parser/base_parser'
-
-module Raph
-  module Parser
-    # Argument is considered as file argument if and only if
-    # corresponding file exist on file system and match
-    # current argument.
-    #
-    # Example:
-    #  'test.rb' - file in current directory with name 'test.rb'
-    #  '*.rb' - all files in current directory with extension 'rb'
-    #  '**/*.xml' - all files in current directory and directories
-    #             that are in this directory with extension 'xml'
-    class FileParser < BaseParser
-      def parse(args)
-        files = []
-        args.each do |a|
-          files.concat Dir[a]
-        end
-        files.uniq
-      end
-    end
-  end
-end
+require 'raph/parser/base_parser'
+
+module Raph
+  module Parser
+    # Argument is considered as file argument if and only if
+    # corresponding file exist on file system and match
+    # current argument.
+    #
+    # Example:
+    #  'test.rb' - file in current directory with name 'test.rb'
+    #  '*.rb' - all files in current directory with extension 'rb'
+    #  '**/*.xml' - all files in current directory and directories
+    #             that are in this directory with extension 'xml'
+    class FileParser < BaseParser
+      def parse(args)
+        files = []
+        args.each do |a|
+          files.concat Dir[a]
+        end
+        files.uniq
+      end
+    end
+  end
+end

data/lib/raph/parser/flag_parser.rb

@@ -1,31 +1,31 @@
-require 'raph/parser/base_parser'
-
-module Raph
-  module Parser
-    # Considers option as flag if and only if
-    # it's name starts with one dash and follows by
-    # one word character or starts with two dashes
-    # and follows by 2 or more word chacters or dashes.
-    #
-    # Assumes that each option doesn't have spaces.
-    #
-    # Example of flags:
-    #   '-h' '-T' '--config'
-    #
-    # Example of non-flags:
-    #   'option' '---option2' '--h'
-    class FlagParser < BaseParser
-      def parse(args)
-        flags = []
-        args.each do |a|
-          flags << a if flag? a
-        end
-        flags
-      end
-
-      def flag?(option)
-        option =~ /^-[\w]$/ || option =~ /^--[\w][\w-]+$/
-      end
-    end
-  end
-end
+require 'raph/parser/base_parser'
+
+module Raph
+  module Parser
+    # Considers option as flag if and only if
+    # it's name starts with one dash and follows by
+    # one word character or starts with two dashes
+    # and follows by 2 or more word chacters or dashes.
+    #
+    # Assumes that each option doesn't have spaces.
+    #
+    # Example of flags:
+    #   '-h' '-T' '--config'
+    #
+    # Example of non-flags:
+    #   'option' '---option2' '--h'
+    class FlagParser < BaseParser
+      def parse(args)
+        flags = []
+        args.each do |a|
+          flags << to_underscored_sym(a) if flag? a
+        end
+        flags
+      end
+
+      def flag?(option)
+        option =~ /^-[\w]$/ || option =~ /^--[\w][\w-]+$/
+      end
+    end
+  end
+end

data/lib/raph/version.rb

@@ -1,3 +1,3 @@
-module Raph
-  VERSION = '0.0.1'
-end
+module Raph
+  VERSION = '0.0.2'
+end

data/raph.gemspec

@@ -1,26 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'raph/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'raph'
-  spec.version       = Raph::VERSION
-  spec.authors       = ['Vitalii Elenhaupt']
-  spec.email         = ['velenhaupt@gmail.com']
-  spec.summary       = 'Ruby Argument Parsing for Humans.'
-  spec.description   = 'Simple argument parser.'
-  spec.homepage      = 'https://github.com/veelenga/raph'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($RS)
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^spec\//)
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '>= 1.9.3'
-
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'raph'
+  spec.version       = Raph::VERSION
+  spec.authors       = ['Vitalii Elenhaupt']
+  spec.email         = ['velenhaupt@gmail.com']
+  spec.summary       = 'Ruby Argument Parsing for Humans.'
+  spec.description   = <<-DESC
+    Lightweight argument parsing with flexible structure.
+    Add your parser in few minutes.
+  DESC
+  spec.homepage      = 'https://github.com/veelenga/raph'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/spec/raph/parser/assinment_parser_spec.rb

@@ -1,46 +1,45 @@
-require 'spec_helper'
-
-module Raph
-  module Parser
-    describe AssignmentParser do
-      describe '#id' do
-        it 'has correct form' do
-          expect(subject.id).to eq :assignments
-        end
-      end
-
-      describe '#parse' do
-        it 'returns assignments only' do
-          expect(subject.parse(['-h', '-on=20', '--two=my-file'])).
-            to match_array(['-on=20', '--two=my-file'])
-        end
-
-        it 'has no to return assignments here' do
-          expect(subject.parse(['-h', 'file', '=', '123'])).
-            to match_array([])
-          expect(subject.parse([])).to match_array([])
-        end
-      end
-
-      describe '#assignment?' do
-        def ass?(option)
-          subject.assignment? option
-        end
-
-        it 'is an assignment' do
-          expect(ass? 'h=one').to be true
-          expect(ass? '-ass=two').to be true
-          expect(ass? '--ass=two').to be true
-          expect(ass? 'ass=one=two').to be true
-        end
-
-        it 'is not as assignment' do
-          expect(ass? '-h').to be false
-          expect(ass? '-h=').to be false
-          expect(ass? 'h=').to be false
-          expect(ass? '=').to be false
-        end
-      end
-    end
-  end
-end
+require 'spec_helper'
+
+module Raph
+  module Parser
+    describe AssignmentParser do
+      describe '#id' do
+        it 'has correct form' do
+          expect(subject.id).to eq :assignments
+        end
+      end
+
+      describe '#parse' do
+        it 'returns assignments only' do
+          parsed = subject.parse(['-h', '-on=20', '--two=my-file'])
+          expect(parsed).to include(:on => '20', :two => 'my-file')
+        end
+
+        it 'has no to return assignments here' do
+          expect(subject.parse(['-h', 'file', '=', '123'])).to be_empty
+          expect(subject.parse([])).to be_empty
+        end
+      end
+
+      describe '#assignment?' do
+        def ass?(option)
+          subject.assignment? option
+        end
+
+        it 'is an assignment' do
+          expect(ass? 'h=one').to be true
+          expect(ass? '-ass=two').to be true
+          expect(ass? '--ass=two').to be true
+        end
+
+        it 'is not as assignment' do
+          expect(ass? '-h').to be false
+          expect(ass? '-h=').to be false
+          expect(ass? 'h=').to be false
+          expect(ass? '=').to be false
+          expect(ass? '-h=one=two').to be false
+        end
+      end
+    end
+  end
+end

data/spec/raph/parser/base_parser_spec.rb

@@ -1,47 +1,47 @@
-require 'spec_helper'
-
-module Raph
-  module Parser
-    describe BaseParser do
-      describe '#id' do
-        it 'returns correct value for base class' do
-          expect(subject.id).to eql :bases
-        end
-
-        it 'returns correct value for child class' do
-          class BaseArgumentParser < BaseParser; end
-          expect(BaseArgumentParser.new.id).to eql :base_arguments
-        end
-
-        it 'returns correct value for modulized class' do
-          module A
-            module B
-              class TestParser < BaseParser; end
-            end
-          end
-          expect(A::B::TestParser.new.id).to eql :tests
-        end
-
-        it 'is correct when no name convention' do
-          class Plural < BaseParser; end
-          expect(Plural.new.id).to eql :plurals
-        end
-
-        it 'can be redefined' do
-          class Plural < BaseParser
-            def id
-              :tests
-            end
-          end
-          expect(Plural.new.id).to eql :tests
-        end
-      end
-
-      describe '#parse' do
-        it 'returns args' do
-          expect(subject.parse [1, 2, 3]).to be nil
-        end
-      end
-    end
-  end
-end
+require 'spec_helper'
+
+module Raph
+  module Parser
+    describe BaseParser do
+      describe '#id' do
+        it 'returns correct value for base class' do
+          expect(subject.id).to eql :bases
+        end
+
+        it 'returns correct value for child class' do
+          class BaseArgumentParser < BaseParser; end
+          expect(BaseArgumentParser.new.id).to eql :base_arguments
+        end
+
+        it 'returns correct value for modulized class' do
+          module A
+            module B
+              class TestParser < BaseParser; end
+            end
+          end
+          expect(A::B::TestParser.new.id).to eql :tests
+        end
+
+        it 'is correct when no name convention' do
+          class Plural < BaseParser; end
+          expect(Plural.new.id).to eql :plurals
+        end
+
+        it 'can be redefined' do
+          class Plural < BaseParser
+            def id
+              :tests
+            end
+          end
+          expect(Plural.new.id).to eql :tests
+        end
+      end
+
+      describe '#parse' do
+        it 'returns args' do
+          expect(subject.parse [1, 2, 3]).to be nil
+        end
+      end
+    end
+  end
+end