binder_core 0.1.0

data/spec/binder_core/parsers/folder_parser_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe BinderCore::FolderParser do
+   let(:path)    { File.join(BINDER_DEFAULT_DIR, "test") }
+   let(:file)    { BinderCore::FileRef.new path }
+   let(:context) { double("FileContext", :file => file ) }
+   let(:content) { {:file => "value"} }
+
+   it "should call descend into a folder and add the response to to file context data" do
+     parser = BinderCore::FolderParser.new context
+     context.should_receive(:descend).and_return(:data =>  content)
+     context.should_receive(:data=).with(content)
+     parser.parse
+   end
+end

data/spec/binder_core/parsers/null_parser_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe BinderCore::NullParser do
+  it "should do nothing with the context when parse is callled" do
+    context = double("FileContext")
+    parser = BinderCore::NullParser.new context
+    parser.parse
+  end
+end

data/spec/binder_core/parsers/text_parser_spec.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe BinderCore::TextParser do
+  let(:path)    { File.join(BINDER_DEFAULT_DIR, "test", "testfile.txt") }
+  let(:file)    { BinderCore::FileRef.new path }
+  let(:context) { double("FileContext", :file => file ) }
+  let(:content) { "This is a test file\n\nTwo lines down\n\nSymbols: \"\"'\\|[]{},.<>/?`~±§!@£$%^&*()_+-=" }
+  
+  it "should read a UTF-8 text file" do
+    parser = BinderCore::TextParser.new context
+    context.should_receive(:data=).with(content)
+    parser.parse
+  end
+end

data/spec/binder_core/registry_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe BinderCore::Registry do
+  let(:path)                 { "/test/" }
+  let(:binder)               { BinderCore::Binder.new(:object) }
+  let(:other_binder)         { BinderCore::Binder.new(:string) }
+  let(:registry_name)        { "Binder" }
+
+  subject { BinderCore::Registry.new(registry_name) }
+
+  it { should be_kind_of(Enumerable) }
+
+  it "finds a registered binder" do
+    subject.add(binder)
+    subject.find(binder.name).should == binder
+  end
+
+  it "raises when finding an unregistered binder" do
+    expect { subject.find(:bogus) }.to raise_error(ArgumentError, "Binder not registered: bogus")
+  end
+
+  it "adds and returns a binder" do
+    subject.add(binder).should == binder
+  end
+
+  it "knows that a binder is registered by symbol" do
+    subject.add(binder)
+    subject.should be_registered(binder.name.to_sym)
+  end
+
+  it "knows that a binder is registered by string" do
+    subject.add(binder)
+    subject.should be_registered(binder.name.to_s)
+  end
+
+  it "knows that a binder isn't registered" do
+    subject.should_not be_registered("bogus")
+  end
+
+  it "can be accessed like a hash" do
+    subject.add(binder)
+    subject[binder.name].should == binder
+  end
+
+  it "iterates registered binders" do
+    subject.add(binder)
+    subject.add(other_binder)
+    subject.to_a.should =~ [binder, other_binder]
+  end
+
+  it "doesn't allow a duplicate name" do
+    expect { 2.times { subject.add(binder) } }.
+      to raise_error(BinderCore::DuplicateDefinitionError, "Binder already registered: object")
+  end
+
+  it "clears registered binders" do
+    subject.add(binder)
+    subject.clear
+    subject.count.should be_zero
+  end
+end

data/spec/binder_core/scanner_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe BinderCore::Scanner do
+  describe "#scan" do
+    let(:stack)      { double("stackMock").as_null_object }
+    let(:console)   { double("ConsoleMock", :stack => stack) }
+    let(:context)   { double("FileConextMock", :console => console, :route => [] ).as_null_object }
+    let(:config)    { double("ConfigMock") }
+    let(:parser)    { double("ParserMock" ).as_null_object }
+    
+    before(:each) do
+      BinderCore::FileContext.should_receive(:new).and_return(context)
+      BinderCore::Config.should_receive(:new).with(context).and_return(config)
+      BinderCore::Scanner.should_receive(:get_parser_for).with(context).and_return(parser)
+    end
+    it "should create and configure a new file context" do
+      BinderCore::Scanner.scan lambda { |confg|  }
+    end
+      
+    it "should add the file context to the stack" do
+      stack.should_receive(:add_file).with( [], context)
+      BinderCore::Scanner.scan lambda { |confg|  }
+    end
+    
+    it "should parse the file context and return it" do
+      parser.should_receive(:parse)
+      BinderCore::Scanner.scan( lambda { |confg|  }).should == context
+    end
+  end
+  
+  describe "#get_parser_for" do
+    it "should return the first parser that matches file context" do
+      rules = [double("RuleMock1"), double("RuleMock2"),double("RuleMock3")]
+      parsers = [double("ParserMock1"), double("ParserMock2"),double("ParserMock3")]
+      context = double("ContextMock")
+      context.should_receive(:rules).and_return(rules)
+      context.should_receive(:parsers).and_return(parsers)
+      i = 0
+      [*rules,*parsers].each do |defn|
+        if i < 3
+          defn.should_receive(:test).and_return(nil)
+        elsif i==3
+          defn.should_receive(:test).and_return(BinderCore::Parser) 
+        else
+          defn.should_not_receive(:test)
+        end
+        i+=1
+      end
+      BinderCore::Scanner.send(:get_parser_for,context)
+    end
+  end
+  
+  describe "#descend" do
+    let(:raw)     { {:data => "value", :assets => []} }
+    let(:context) { double("FileContextMock", :raw => raw).as_null_object }
+    
+    before(:each) do
+      BinderCore::FolderContext.should_receive(:new).and_return(context)
+    end
+    
+    it "should crate a new folder context" do
+      raw = BinderCore::Scanner.descend lambda{ |config|  }
+    end
+
+    it "should call parse files on the folder context and return the result" do
+      context.should_receive(:parse_files).and_return raw
+      BinderCore::Scanner.descend(lambda{ |config| }).should == raw
+    end
+
+    it "should execute a passed in block on a config object" do
+      config = double("Config")
+      config.should_receive("test")
+      BinderCore::Scanner.descend lambda{ |c|
+        config.test
+        c.should be_kind_of(BinderCore::Config)
+      }
+    end
+  end
+end

data/spec/binder_core/settings_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe BinderCore::Settings do
+  before(:each) do
+    BinderCore::Settings.configure do
+      config.base_asset_url = "test"
+      config.content_folder = "test"
+    end
+  end
+  
+  it "should allow configure call with a proc that has access to instance methods" do
+    BinderCore::Settings.config.base_asset_url.should == "test"
+    BinderCore::Settings.config.content_folder.should == "test"
+  end
+  
+  it "should clone the comfig object when propegate is called" do
+    conf = BinderCore::Settings.config
+    conf2 = BinderCore::Settings.propegate
+    conf2.base_asset_url = "test2"
+    conf2.content_folder = "test2"
+    
+    conf.base_asset_url.should_not == conf2.base_asset_url
+    conf.content_folder.should_not == conf2.content_folder
+  end
+end
+
+describe BinderCore::Settings::Config do
+  it "should provide a list of its public properties through prop_list" do
+    c = BinderCore::Settings::Config.new
+    c.prop_list.should == [:base_asset_folder, :base_asset_folder=, :base_asset_url, :base_asset_url=, :content_folder,  :content_folder=, :folder_size_limit_mb, :folder_size_limit_mb=]
+  end
+end

data/spec/binder_core_spec.rb

@@ -0,0 +1,87 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+describe BinderCore do
+  describe "#define" do
+    after(:each) { BinderCore.binders.clear }
+    
+    it "should return a Binder data object from binder_by_name method" do
+      test = BinderCore.define :test
+      test.should_not be_nil
+      test.name.should == :test
+    end
+
+    it "should register a second binder object with a different name" do
+      BinderCore.define :test
+      newname = :test2
+      test2 = BinderCore.define newname
+      test2.should_not be_nil
+      test2.name.should == newname
+    end
+    
+    it "should add a config Proc to the Binder Object" do
+      test = BinderCore.define( :test ) {}
+      test.config.should be_a(Proc)
+    end
+  end
+  
+  describe "#binder_by_name" do
+    before(:each) do
+      @test = BinderCore.define :test
+    end
+    
+    it "should get the binder object by its name" do
+      binder = BinderCore.binder_by_name "test"
+      binder.should == @test
+    end
+  end
+  
+  describe "#build" do
+    before(:all) do
+      BinderCore::Compiler.configure do
+        config.base_asset_url = ASSET_BASE_URL
+        config.content_folder = BINDER_DEFAULT_DIR
+      end
+      BinderCore.binders.clear
+      BinderCore.define :test
+      @binder = BinderCore.compile("test")
+      @data = @binder.raw[:data]
+      @assets = @binder.raw[:assets]
+    end
+    after(:all) { BinderCore.binders.clear }
+    
+    it "should build the feed from the test content folder" do
+      @data.should_not be_nil
+    end
+    
+    it "should should have a testfile property with the contents of testfile.txt" do
+      @data["testfile"].should == "This is a test file\n\nTwo lines down\n\nSymbols: \"\"'\\|[]{},.<>/?`~±§!@£$%^&*()_+-="
+    end
+    
+    it "should have an asset for the logo png and the asset should be in the assets array" do
+      asset = @data["logo"]
+      asset.should be_kind_of(BinderCore::Asset)
+      asset.file.path.should == File.join(BINDER_DEFAULT_DIR, "test", "logo.png")
+      asset.asset_url.should == "http://www.BinderCore.com/assets/test/logo.png"
+      @assets.should include(asset)
+    end
+    
+    it "should have set the base path property of each asset object" do
+      @assets.each { |asset| asset.base_url.should == ASSET_BASE_URL }
+    end
+    
+    it "should ignore empty folders" do
+      @data.keys.should_not include("emptyfolder")
+    end
+    
+    it "should ignore files/folders with names beginning with an underscore" do
+      @data.keys.should_not include("_hidden_file")
+      @data.keys.should_not include("_hidden_folder")
+    end
+    
+    it "should ignore files types it doesnt recognise" do
+      @data.keys.should_not include("unknown")  
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rspec'
+require 'rspec/autorun'
+require 'rspec/mocks'
+
+require "binder_core"
+
+RSpec.configure do |config|   
+  
+  BINDER_DEFAULT_DIR  = File.join(File.dirname(__FILE__),"support", "content")
+  ASSET_BASE_URL     = "http://www.BinderCore.com/assets/"
+
+  config.after do
+    
+  end
+end

data/spec/support/content/test/_hidden_file.txt

@@ -0,0 +1 @@
+This should not be added to the feed because the file name starts with an underscore

data/spec/support/content/test/_hidden_folder/childofhiddenfolder.txt

@@ -0,0 +1 @@
+this should not be in the feed because a parent folder should be hidden

data/spec/support/content/test/emptyfolder/_ignore.txt

@@ -0,0 +1 @@
+this files is ignored so the containing folder is considered emtpy

data/spec/support/content/test/subfolder/subtext.txt

@@ -0,0 +1 @@
+This is sub text

data/spec/support/content/test/testfile.txt

@@ -0,0 +1,5 @@
+This is a test file
+
+Two lines down
+
+Symbols: ""'\|[]{},.<>/?`~±§!@£$%^&*()_+-=

data/spec/support/content/test/unknown.tmp

@@ -0,0 +1 @@
+this is an unknown file format and should be ignored

data/spec/support/parsers/test_parsers.rb

@@ -0,0 +1,20 @@
+module TestParsers
+  class TestParser < BinderCore::Parser
+    def parse
+      add "test_parser"
+    end
+  end
+  
+  class TestAssetParser < BinderCore::Parser
+    def parse
+      add new_asset( @context.file.path).with_name( @context.file.name ) 
+    end
+  end
+  
+  class TestFolderParser < BinderCore::Parser
+    def parse
+      ret = {:file_key => "file_value"}
+      add ret
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: binder_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ruaidhri Devery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby framework for compiling data from a file system
+email:
+- info@fluid.ie
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- binder_core.gemspec
+- lib/binder_core.rb
+- lib/binder_core/asset.rb
+- lib/binder_core/binder.rb
+- lib/binder_core/compiler.rb
+- lib/binder_core/config.rb
+- lib/binder_core/console.rb
+- lib/binder_core/debug/stack.rb
+- lib/binder_core/defaults.rb
+- lib/binder_core/definition.rb
+- lib/binder_core/file_context.rb
+- lib/binder_core/file_ref.rb
+- lib/binder_core/folder_context.rb
+- lib/binder_core/parser.rb
+- lib/binder_core/parsers/asset_parser.rb
+- lib/binder_core/parsers/folder_parser.rb
+- lib/binder_core/parsers/null_parser.rb
+- lib/binder_core/parsers/text_parser.rb
+- lib/binder_core/registry.rb
+- lib/binder_core/scanner.rb
+- lib/binder_core/settings.rb
+- lib/binder_core/version.rb
+- spec/binder_core/asset_spec.rb
+- spec/binder_core/binder_spec.rb
+- spec/binder_core/compiler_spec.rb
+- spec/binder_core/config_spec.rb
+- spec/binder_core/console_spec.rb
+- spec/binder_core/debug/stack_spec.rb
+- spec/binder_core/defaults_spec.rb
+- spec/binder_core/definition_spec.rb
+- spec/binder_core/file_context_spec.rb
+- spec/binder_core/file_ref_spec.rb
+- spec/binder_core/folder_context_spec.rb
+- spec/binder_core/parser_spec.rb
+- spec/binder_core/parsers/asset_parser_spec.rb
+- spec/binder_core/parsers/folder_parser_spec.rb
+- spec/binder_core/parsers/null_parser_spec.rb
+- spec/binder_core/parsers/text_parser_spec.rb
+- spec/binder_core/registry_spec.rb
+- spec/binder_core/scanner_spec.rb
+- spec/binder_core/settings_spec.rb
+- spec/binder_core_spec.rb
+- spec/spec_helper.rb
+- spec/support/content/test/_hidden_file.txt
+- spec/support/content/test/_hidden_folder/childofhiddenfolder.txt
+- spec/support/content/test/emptyfolder/_ignore.txt
+- spec/support/content/test/logo.png
+- spec/support/content/test/subfolder/subtext.txt
+- spec/support/content/test/testfile.txt
+- spec/support/content/test/unknown.tmp
+- spec/support/parsers/test_parsers.rb
+homepage: https://github.com/rur/Binder-Core
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: binder_core
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Folder content compiler
+test_files:
+- spec/binder_core/asset_spec.rb
+- spec/binder_core/binder_spec.rb
+- spec/binder_core/compiler_spec.rb
+- spec/binder_core/config_spec.rb
+- spec/binder_core/console_spec.rb
+- spec/binder_core/debug/stack_spec.rb
+- spec/binder_core/defaults_spec.rb
+- spec/binder_core/definition_spec.rb
+- spec/binder_core/file_context_spec.rb
+- spec/binder_core/file_ref_spec.rb
+- spec/binder_core/folder_context_spec.rb
+- spec/binder_core/parser_spec.rb
+- spec/binder_core/parsers/asset_parser_spec.rb
+- spec/binder_core/parsers/folder_parser_spec.rb
+- spec/binder_core/parsers/null_parser_spec.rb
+- spec/binder_core/parsers/text_parser_spec.rb
+- spec/binder_core/registry_spec.rb
+- spec/binder_core/scanner_spec.rb
+- spec/binder_core/settings_spec.rb
+- spec/binder_core_spec.rb
+- spec/spec_helper.rb
+- spec/support/content/test/_hidden_file.txt
+- spec/support/content/test/_hidden_folder/childofhiddenfolder.txt
+- spec/support/content/test/emptyfolder/_ignore.txt
+- spec/support/content/test/logo.png
+- spec/support/content/test/subfolder/subtext.txt
+- spec/support/content/test/testfile.txt
+- spec/support/content/test/unknown.tmp
+- spec/support/parsers/test_parsers.rb