booby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 580e3da73af31344e0932d62b61c2eca1d96e581
+  data.tar.gz: 0a30866d2bafcfbb14f93ca38d6b83eec8155d19
+SHA512:
+  metadata.gz: 2c0389b02e6628b40c99fc7fa57a987d23b6082a4a88b890c12640e42109c27c561a0f9106bb940856ff05643d9c5915676e4a46e1b53153e9c9c80a8cc7021e
+  data.tar.gz: ad3468bf0e854b5b1fc776af68c3862bf4573e2352565bd9366ba9b7a05bce99260f91372369cf071fa927a0399a64e11bb1745b1019ff9bca5b63cb82a3cc51

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+\#*
+.\#*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in booby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Hmurca Team
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Booby
+
+*Booby* is a super simple and stupid file parser scaffold. It parses very simple
+config files into set of lines (commands with arguments) that are passed to actual
+parser classes (processors).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'booby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install booby
+
+## Usage
+
+Check project documentation [here](http://docs.hmurca.com/en/latest/booby.html).
+
+## Contributing
+
+1. Work on your changes in a feature branch.
+2. Make sure that tests are passing.
+3. Send a pull request.
+4. Wait for feedback.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.pattern = "test/*_test.rb"
+  t.verbose = false
+end
+
+task :default => :test

data/booby.gemspec

@@ -0,0 +1,24 @@
+# -*- mode: ruby -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'booby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "booby"
+  spec.version       = Booby::VERSION
+  spec.authors       = ["Hmurca Team"]
+  spec.email         = ["dev@hmurca.com"]
+  spec.description   = %q{Stupid config files parser scaffold.}
+  spec.summary       = %q{Booby is a config files parser scaffold.}
+  spec.homepage      = "http://docs.hmurca.com/en/latest/booby.html"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/lib/booby.rb

@@ -0,0 +1,24 @@
+require "booby/version"
+
+module Booby
+  require "booby/errors"
+  require "booby/parser"
+
+  # Public: Initializes a parser with given source code.
+  #
+  # source - The String source code of a config file.
+  #
+  # Returns initialized Parser.
+  def self.prepare(source)
+    return Parser.new(source)
+  end
+
+  # Public: Initializes a parser with loaded source code.
+  #
+  # source - The String file name to load.
+  #
+  # Returns initialized Parser.
+  def self.open(fname)
+    return Parser.new(File.read(fname))
+  end
+end

data/lib/booby/errors.rb

@@ -0,0 +1,33 @@
+module Booby
+  # Public: General error class.
+  class Error < StandardError
+  end
+
+  # Public: Error raised when processor returns unexpected stuff.
+  class InvalidResponseError < Error
+    def initialize(obj)
+      super(
+        "Invalid response from processor. Expected `true', `false'" +
+        "or an instance of processor, got: #{obj.inspect}"
+      )
+    end
+  end
+
+  # Public: Error raised when processor stumbles upon an unsupported option.
+  class UnsupportedOptionError < Error
+    def initialize(cmd, line_no)
+      super("Unsupported option (line #{line_no}): #{cmd}")
+    end
+  end
+
+  # Public: Error raised when arity check fails.
+  class InvalidNumberOfParametersError < Error
+    def initialize(expected, actual, cmd, line_no)
+      expected = "minimum 1" if expected === true
+      super(
+        "Invalid number of parameters (line #{line_no}): "+
+        "#{cmd} expects #{expected} parameter(s), got #{actual}"
+      )
+    end
+  end
+end

data/lib/booby/parser.rb

@@ -0,0 +1,84 @@
+module Booby
+  # Public: Generic configuration parser. You shouldn't access this
+  # class directly, use Booby#open and Booby#prepare instead.
+  class Parser
+    # Public: Initializer.
+    #
+    # source - The String source code of a config file.
+    #
+    def initialize(source)
+      @source = source
+    end
+
+    # Public: Parses initialized config source with using given processor
+    # class. The processor class must implement #process instance method.
+    #
+    # processor - The processor class to parse source with.
+    #
+    # Returns processor instance that contains parsed data.
+    def parse_with(processor)
+      processor.new.tap do |p|
+        @__root_processor = @__current_processor = p
+        @source.split(/$/).each_with_index { |line, i| process_line(line, i) }
+      end
+    end
+
+    private
+
+    # Internal: Processes single line from source file.
+    #
+    # line    - The String line to be processed.
+    # line_no - The Integer current line number.
+    #
+    # Returns nothing.
+    def process_line(line, line_no)
+      line.strip!
+
+      return if line =~ /^\#/ # Skip comment lines...
+
+      if line.empty?
+        # Skip empty line and close recent processing group (if any)...
+        @__current_processor = @__root_processor
+        return
+      end
+
+      cmd, *args = line.split
+
+      # Check arity for this command...
+      arity = @__current_processor.class.const_get(:ARITY) rescue nil
+      arity = arity[cmd] if arity
+
+      case arity
+      when true
+        if args.empty?
+          raise InvalidNumberOfParametersError.new(
+            arity, args.size, cmd, line_no
+          )
+        end
+      when Integer
+        if args.size != arity
+          raise InvalidNumberOfParametersError.new(
+            arity, args.size, cmd, line_no
+          )
+        end
+      end
+
+      # Parse...
+      res = @__current_processor.process(cmd, *args)
+
+      # Check result...
+      case res
+      when true
+        return
+      when false
+        raise UnsupportedOptionError.new(cmd, line_no)
+      else
+        unless res.respond_to?(:process)
+          raise InvalidResponseError.new(res)
+        end
+
+        @__current_processor = res
+      end
+    end
+  end
+end

data/lib/booby/version.rb

@@ -0,0 +1,3 @@
+module Booby
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+require "minitest/autorun"
+require "fileutils"
+require "booby"
+
+$test_tmp_dir = File.expand_path("../../tmp", __FILE__)
+FileUtils.mkdir_p($test_tmp_dir)

data/test/parser_test.rb

@@ -0,0 +1,256 @@
+require File.expand_path("../helper.rb", __FILE__)
+
+class SimpleProcessor
+  attr_reader :foo, :bar
+
+  def process(cmd, *args)
+    case cmd
+    when "foo"
+      @foo = args
+    when "bar"
+      @bar = args
+    else
+      return false
+    end
+
+    true
+  end
+end
+
+SIMPLE_FILE = <<END
+foo 1
+bar 1 2
+foo 1 2 3
+END
+
+SIMPLE_FILE_WITH_COMMENTS = <<END
+foo 1
+# this is a comment
+bar 1 2
+
+# and another one
+# and another...
+foo 1 2 3
+END
+
+class GroupProcessor
+  attr_reader :foos
+
+  def process(cmd, *args)
+    case cmd
+    when "foo"
+      @foos ||= []
+      @foos << args.first
+    else
+      return false
+    end
+
+    true
+  end
+end
+
+class GroupedProcessor
+  attr_reader :group, :bar
+
+  def process(cmd, *args)
+    case cmd
+    when "bar"
+      @bar = args
+    when "group"
+      @group = GroupProcessor.new
+      return @group
+    else
+      return false
+    end
+
+    true
+  end
+end
+
+class InvalidGroupedProcessor
+  attr_reader :group, :bar
+
+  def process(cmd, *args)
+    case cmd
+    when "bar"
+      @bar = args
+    when "group"
+      return Object.new
+    else
+      return false
+    end
+
+    true
+  end
+end
+
+ONE_GROUP_FILE = <<END
+bar 1 2
+
+group
+foo 3
+foo 4
+END
+
+class RepeatableGroupedProcessor
+  attr_reader :group, :bar
+
+  def process(cmd, *args)
+    case cmd
+    when "bar"
+      @bar = args
+    when "group"
+      @group ||= []
+      @group << (g = GroupProcessor.new)
+      return g
+    else
+      return false
+    end
+
+    true
+  end
+end
+
+REPEATED_GROUP_FILE = <<END
+bar 0
+
+group
+foo 3
+foo 4
+
+bar 1 2
+
+group
+foo 5
+foo 6
+END
+
+class InvalidResponseProcessor
+  def process(cmd, *args)
+    return "foo"
+  end
+end
+
+UNSUPPORTED_OPTION_FILE = <<END
+foo 1 2
+baz 1
+END
+
+class ArityCheckProcessor
+  ARITY = {
+    'foo' => 1,
+    'baz' => true
+  }
+
+  attr_reader :foo, :bar, :baz
+
+  def process(cmd, *args)
+    case cmd
+    when "foo"
+      @foo = args
+    when "bar"
+      @bar = args
+    when "baz"
+      @baz = args
+    else
+      return false
+    end
+
+    true
+  end
+end
+
+WRONG_ARITY_FILE_1 = <<END
+foo 1 2
+bar 1 2
+baz 1 2 3 4
+END
+
+WRONG_ARITY_FILE_2 = <<END
+foo 1
+bar 1 2
+baz
+END
+
+CORRECT_ARITY_FILE = <<END
+foo 1
+bar 1 2 3 4
+baz 1 2 3 4
+END
+
+
+class TestParser < Minitest::Test
+  def test_simple_processing
+    b = Booby.prepare(SIMPLE_FILE)
+    parsed = b.parse_with(SimpleProcessor)
+    assert_equal %w{1 2 3}, parsed.foo
+    assert_equal %w{1 2}, parsed.bar
+  end
+
+  def test_simple_processing_with_comments
+    b = Booby.prepare(SIMPLE_FILE_WITH_COMMENTS)
+    parsed = b.parse_with(SimpleProcessor)
+    assert_equal %w{1 2 3}, parsed.foo
+    assert_equal %w{1 2}, parsed.bar
+  end
+
+  def test_basic_groups_processing
+    b = Booby.prepare(ONE_GROUP_FILE)
+    parsed = b.parse_with(GroupedProcessor)
+    assert_equal %w{1 2}, parsed.bar
+    assert_equal %w{3 4}, parsed.group.foos
+  end
+
+  def test_multiple_groups
+    b = Booby.prepare(REPEATED_GROUP_FILE)
+    parsed = b.parse_with(RepeatableGroupedProcessor)
+    assert_equal %w{1 2}, parsed.bar
+    assert_equal %w{3 4}, parsed.group[0].foos
+    assert_equal %w{5 6}, parsed.group[1].foos
+  end
+
+  def test_invalid_response
+    b = Booby.prepare(ONE_GROUP_FILE)
+    assert_raises Booby::InvalidResponseError do
+      b.parse_with(InvalidResponseProcessor)
+    end
+  end
+
+  def test_unsupported_option
+    b = Booby.prepare(UNSUPPORTED_OPTION_FILE)
+    assert_raises Booby::UnsupportedOptionError do
+      b.parse_with(SimpleProcessor)
+    end
+  end
+
+  def test_file_opening
+    testfile = "./tmp/test.conf"
+    File.open(testfile, "w+") { |f| f.puts(SIMPLE_FILE) }
+    b = Booby.open(testfile)
+    parsed = b.parse_with(SimpleProcessor)
+    assert_equal %w{1 2 3}, parsed.foo
+    assert_equal %w{1 2}, parsed.bar
+  end
+
+  def test_strict_arity_checking_fail
+    b = Booby.prepare(WRONG_ARITY_FILE_1)
+    assert_raises Booby::InvalidNumberOfParametersError do
+      parsed = b.parse_with(ArityCheckProcessor)
+    end
+  end
+
+  def test_minimum_arity_checking_fail
+    b = Booby.prepare(WRONG_ARITY_FILE_2)
+    assert_raises Booby::InvalidNumberOfParametersError do
+      parsed = b.parse_with(ArityCheckProcessor)
+    end
+  end
+
+  def test_arity_checking_success
+    b = Booby.prepare(CORRECT_ARITY_FILE)
+    parsed = b.parse_with(ArityCheckProcessor)
+    assert_equal %w{1}, parsed.foo
+    assert_equal %w{1 2 3 4}, parsed.bar
+    assert_equal %w{1 2 3 4}, parsed.bar
+  end
+end

data/test/version_test.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../helper.rb", __FILE__)
+
+class TestVersion < Minitest::Test
+  def test_version_number
+    assert_equal Booby::VERSION, "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: booby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hmurca Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stupid config files parser scaffold.
+email:
+- dev@hmurca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- booby.gemspec
+- lib/booby.rb
+- lib/booby/errors.rb
+- lib/booby/parser.rb
+- lib/booby/version.rb
+- test/helper.rb
+- test/parser_test.rb
+- test/version_test.rb
+homepage: http://docs.hmurca.com/en/latest/booby.html
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Booby is a config files parser scaffold.
+test_files:
+- test/helper.rb
+- test/parser_test.rb
+- test/version_test.rb