brock 0.1.1 → 0.1.2

data/lib/brock.rb

@@ -1,18 +1,2 @@
 require 'brock/schema'
 require 'brock/version'
-
-module Brock
-
-  def self.version
-    VERSION
-  end
-
-  def self.to_html(schema, values, options={})
-    Schema.new(schema).to_html(values)
-  end
-
-  def self.parse_params(schema, params)
-    Schema.new(schema).parse_paras(params)
-  end
-
-end

data/lib/brock/field.rb

@@ -13,13 +13,16 @@ module Brock
 
     attr_reader :description
 
-    def initialize(params = {})
-      @type = params.fetch('type').to_sym
-      @name = params.fetch('name').to_sym
-      @label = params.fetch('label')
-      @default = params.fetch('default')
+    def self.detect(params)
+      params['type'] == type.to_s
+    end
+
+    def self.new_from_params(params)
+      new(params.fetch('name'), params)
+    end
 
-      @description = params['description']
+    def initialize(name, params = {})
+      @name, @params = name.to_sym, params
     end
 
     def to_html(value=nil)
@@ -27,7 +30,20 @@ module Brock
     end
 
     def parse_param(value)
-      raise ParamParseError
+      raise ParamParseError.new(value)
+    end
+
+    def label
+      @params['label'] or
+      name.to_s.gsub(/[^[:alnum:]]+/,' ').sub(/^(.)/) {|l| l.upcase }
+    end
+
+    def default
+      @params['default']
+    end
+
+    def description
+      @params['description']
     end
 
   end

data/lib/brock/field_template.rb

@@ -27,7 +27,7 @@ module Brock
     end
 
     def path
-      File.join(self.class.share_path, "#{field.type}_field.erb")
+      File.join(self.class.share_path, "#{field.class.type}_field.erb")
     end
 
   end

data/lib/brock/fields/boolean_field.rb

@@ -3,8 +3,20 @@ require 'brock/field'
 module Brock
   class BooleanField < Field
 
+    def self.type
+      :boolean
+    end
+
+    def default
+      if @params.has_key?('default')
+        @params['default']
+      else
+        true
+      end
+    end
+
     def parse_param(value)
-      value == '1' || value == 'true' || value == true
+      value == 'on' || value == '1' || value == 'true' || value == true
     end
 
   end

data/lib/brock/fields/integer_field.rb

@@ -3,10 +3,14 @@ require 'brock/field'
 module Brock
   class IntegerField < Field
 
+    def self.type
+      :integer
+    end
+
     def parse_param(value)
       Integer(value)
-    rescue ArgumentError
-      raise ParamParseError.new(value)
+    rescue ArgumentError, TypeError
+      super(value)
     end
 
   end

data/lib/brock/fields/select_field.rb

@@ -0,0 +1,26 @@
+require 'brock/field'
+
+module Brock
+  class SelectField < Field
+
+    def self.type
+      :select
+    end
+
+    def self.detect(field)
+      super(field) or (
+        field['values'] and
+        (field['type'] == 'string' or not field.has_key?('type'))
+      )
+    end
+
+    def parse_param(value)
+      value.to_s
+    end
+
+    def values
+      @params['values'] || []
+    end
+
+  end
+end

data/lib/brock/fields/string_field.rb

@@ -3,6 +3,14 @@ require 'brock/field'
 module Brock
   class StringField < Field
 
+    def self.type
+      :string
+    end
+
+    def self.detect(field)
+      super(field) or not field.has_key?('type')
+    end
+
     def parse_param(value)
       value.to_s
     end

data/lib/brock/fields/text_field.rb

@@ -0,0 +1,15 @@
+require 'brock/field'
+
+module Brock
+  class TextField < Field
+
+    def self.type
+      :text
+    end
+
+    def parse_param(value)
+      value.to_s
+    end
+
+  end
+end

data/lib/brock/schema.rb

@@ -1,6 +1,8 @@
 require 'brock/fields/boolean_field'
 require 'brock/fields/integer_field'
+require 'brock/fields/select_field'
 require 'brock/fields/string_field'
+require 'brock/fields/text_field'
 
 module Brock
 
@@ -11,36 +13,36 @@ module Brock
 
     attr_reader :fields
 
-    def self.field_for_type(type)
-      case type
-      when 'boolean'
-        BooleanField
-      when 'integer'
-        IntegerField
-      when 'string'
-        StringField
+    FIELD_TYPES = [
+      IntegerField,
+      BooleanField,
+      TextField,
+      SelectField,
+      StringField
+    ]
+
+    def self.field_for(raw)
+      klass = FIELD_TYPES.detect {|type| type.detect(raw) }
+      if klass
+        klass.new_from_params(raw)
       else
-        raise FieldTypeNotSupported
+        raise FieldTypeNotSupported.new(raw)
       end
     end
 
     def initialize(raw_fields)
-      @fields = raw_fields.map do |raw_field|
-        klass = self.class.field_for_type(raw_field.fetch('type'))
-        klass.new(raw_field)
-      end
+      @fields = raw_fields.map {|raw_field| self.class.field_for(raw_field) }
     end
 
     def to_html(values = {})
       fields.map do |field|
-        field.to_html(values[field.name])
+        field.to_html(values[field.name.to_s])
       end.join("\n")
     end
 
     def parse_params(params)
-      params.each_with_object({}) do |(name, value), settings|
-        field = field_with_name(name)
-        settings[field.name] = field.parse_param(value)
+      fields.each_with_object({}) do |field, settings|
+        settings[field.name] = field.parse_param(params[field.name])
       end
     end
 

data/lib/brock/version.rb

@@ -1,3 +1,7 @@
 module Brock
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
+
+  def self.version
+    VERSION
+  end
 end

data/share/boolean_field.erb

@@ -4,10 +4,11 @@
       <input class="brock-field"
              type="checkbox"
              name="brock[<%= name %>]"
-             <% if value || default %>checked<% end %>
+             <% if value || (value.nil? and default) %>
+               checked
+             <% end %>
       />
       <%= label %>
     </label>
   </div>
 </div>
-

data/share/integer_field.erb

@@ -6,7 +6,9 @@
     <input class="brock-field"
            type="number"
            name="brock[<%= name %>]"
-           placeholder="<%= default %>"
+           <% if value %>
+             placeholder="<%= default %>"
+           <% end %>
            <% if value %>
              value="<%= value %>"
            <% end %>

data/share/select_field.erb

@@ -0,0 +1,24 @@
+<div class="control-group brock-field brock-field-select">
+  <div class="control-label">
+    <%= label %>
+  </div>
+
+  <div class="controls">
+    <% values.each do |v| %>
+      <label class="radio brock-label">
+        <input class="brock-field"
+               type="radio"
+               name="brock[<%= name %>]"
+               value="<%= v['value'] %>"
+               <% if value == v['value'] or (not value and v['value'] == default) %>
+                 checked
+               <% end %>
+        />
+        <%= v['label'] %>
+        <% if v['description'] %>
+          <p class="help-block"><%= v['description'] %></p>
+        <% end %>
+      </label>
+    <% end %>
+  </div>
+</div>

data/share/string_field.erb

@@ -4,7 +4,9 @@
     <input class="brock-field"
            type="text"
            name="brock[<%= name %>]"
-           placeholder="<%= default %>"
+           <% if default %>
+             placeholder="<%= default %>"
+           <% end %>
            <% if value %>
              value="<%= value %>"
            <% end %>

data/share/text_field.erb

@@ -0,0 +1,15 @@
+<div class="control-group brock-field brock-field-text">
+  <label class="control-label brock-label"><%= label %></label>
+  <div class="controls">
+    <textarea class="brock-field"
+           name="brock[<%= name %>]"
+           <% if default %>
+             placeholder="<%= default %>"
+           <% end %>
+    /><% if value %><%= value %><% end %></textarea>
+
+    <% if description %>
+      <p class="help-block brock-description"><%= description %></p>
+    <% end %>
+  </div>
+</div>

data/spec/brock/field_template_spec.rb

@@ -23,7 +23,7 @@ describe Brock::FieldTemplate do
   end
 
   it "figures out the correct path" do
-    field.stub(type: 'string')
+    field.stub(class: stub(type: 'string'))
     subject.class.stub(:share_path) { '/' }
     expect(subject.path).to eq('/string_field.erb')
   end

data/spec/brock/fields/boolean_field_spec.rb

@@ -3,21 +3,34 @@ require 'brock/fields/boolean_field'
 
 describe Brock::BooleanField do
 
-  subject {
-    described_class.new(
-      'type' => 'boolean',
-      'name' => 'team_balance',
-      'label' => 'Auto team balance',
-      'default' => true
-    )
-  }
-
-  it "#to_html works" do
-    expect(subject.to_html(false)).to be_similar_to_fixture('boolean_field.html')
+  subject { described_class.new(:espresso) }
+
+  it_behaves_like "a field"
+
+  it "asdf" do
+
+    expect(subject.to_html(true)).to match(/checked/)
+
+  end
+
+  describe ".detect" do
+
+    it "picks fields with type boolean" do
+      expect(described_class.detect('type' => 'boolean'))
+    end
+
+    it "picks fields with boolean defaults" do
+      expect(described_class.detect('default' => true))
+    end
+
   end
 
   describe "#parse_param" do
 
+    it "works with on" do
+      expect(subject.parse_param('on')).to eq(true)
+    end
+
     it "works with 1" do
       expect(subject.parse_param('1')).to eq(true)
     end
@@ -31,4 +44,18 @@ describe Brock::BooleanField do
     end
 
   end
+
+  describe "#default" do
+
+    it "can be set in the constructor" do
+      subject = described_class.new(:latte, 'default' => false)
+      expect(subject.default).to be_false
+    end
+
+    it "defaults to true" do
+      expect(subject.default)
+    end
+
+  end
+
 end

data/spec/brock/fields/integer_field_spec.rb

@@ -3,18 +3,9 @@ require 'brock/fields/integer_field'
 
 describe Brock::IntegerField do
 
-  subject {
-    described_class.new(
-      'type' => 'integer',
-      'name' => 'rounds',
-      'label' => 'Rounds',
-      'default' => 10
-    )
-  }
-
-  it "#to_html works" do
-    expect(subject.to_html(5)).to be_similar_to_fixture('integer_field.html')
-  end
+  subject { described_class.new(:espresso) }
+
+  it_behaves_like "a field"
 
   describe "#parse_param" do
 
@@ -33,4 +24,9 @@ describe Brock::IntegerField do
     end
 
   end
+
+  it "#default is optional" do
+    expect(subject.default).to eq(nil)
+  end
+
 end

data/spec/brock/fields/select_field_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'brock/fields/select_field'
+
+describe Brock::SelectField do
+
+  subject {
+    described_class.new(:espresso, 'values' => [
+      {'value' => 0, 'label' => 'First', 'description' => 'The first'},
+      {'value' => 1, 'label' => 'Second', 'description' => 'The second'}
+    ])
+  }
+
+  it_behaves_like "a field"
+
+  describe ".detect" do
+
+    it "is true for fields without a type and just a value" do
+      expect(described_class.detect("type" => "string", "values" => []))
+    end
+
+    it "is true for fields without a type and just a value" do
+      expect(described_class.detect("values" => []))
+    end
+
+  end
+
+  describe "#parse_param" do
+
+    it "works with string" do
+      expect(subject.parse_param('foo')).to eq('foo')
+    end
+
+    it "calls to_s on other objects" do
+      obj = stub(to_s: 'sentinal')
+      expect(subject.parse_param(obj)).to eq('sentinal')
+    end
+
+  end
+
+  it "#default is optional" do
+    expect(subject.default).to eq(nil)
+  end
+
+end

data/spec/brock/fields/string_field_spec.rb

@@ -3,17 +3,16 @@ require 'brock/fields/string_field'
 
 describe Brock::StringField do
 
-  subject {
-    described_class.new(
-      'type' => 'string',
-      'name' => 'first_name',
-      'label' => 'First name',
-      'default' => 'Chris'
-    )
-  }
-
-  it "#to_html works" do
-    expect(subject.to_html(5)).to be_similar_to_fixture('string_field.html')
+  subject { described_class.new(:espresso) }
+
+  it_behaves_like "a field"
+
+  describe ".detect" do
+
+    it "is true for fields without a type" do
+      expect(described_class.detect({}))
+    end
+
   end
 
   describe "#parse_param" do
@@ -28,4 +27,9 @@ describe Brock::StringField do
     end
 
   end
+
+  it "#default is optional" do
+    expect(subject.default).to eq(nil)
+  end
+
 end

data/spec/brock/fields/text_field_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'brock/fields/text_field'
+
+describe Brock::TextField do
+
+  subject {
+    described_class.new(:espresso)
+  }
+
+  it_behaves_like "a field"
+
+  describe "#parse_param" do
+
+    it "works with string" do
+      expect(subject.parse_param('foo')).to eq('foo')
+    end
+
+  end
+
+  it "#default is optional" do
+    expect(subject.default).to eq(nil)
+  end
+
+end

data/spec/brock/schema_spec.rb

@@ -16,6 +16,10 @@ describe Brock::Schema do
         "type" => "boolean",
         "label" => "Auto Team Balance",
         "default" => true
+      }, {
+        "name" => "first_name",
+        "label" => "First name",
+        "default" => "Chris"
       }
     ]
   }
@@ -26,5 +30,15 @@ describe Brock::Schema do
     expect { subject }.to_not raise_error(Brock::FieldTypeNotSupported)
   end
 
+  {
+    {"name" => "a"} => Brock::StringField,
+    {"name" => "a", "values" => []} => Brock::SelectField,
+    {"name" => "a", "type" => "string", "values" => []} => Brock::SelectField
+  }.each do |raw, klass|
+    it ".field_for matches a shortcut to #{klass}" do
+      described_class.field_for(raw).should be_a(klass)
+    end
+  end
+
 end
 

data/spec/fixtures/boolean_field.html

@@ -1,8 +1,8 @@
 <div class="control-group brock-field brock-field-boolean">
   <div class="controls checkbox">
     <label class="control-label brock-label">
-      <input class="brock-field" type="checkbox" name="brock[team_balance]" checked />
-      Auto team balance
+      <input class="brock-field" type="checkbox" name="brock[espresso]" checked />
+      Espresso
     </label>
   </div>
 </div>

data/spec/fixtures/integer_field.html

@@ -1,6 +1,6 @@
 <div class="control-group brock-field brock-field-integer">
-  <label class="control-label brock-label">Rounds</label>
+  <label class="control-label brock-label">Espresso</label>
   <div class="controls">
-    <input class="brock-field" type="number" name="brock[rounds]" placeholder="10" value="5" />
+    <input class="brock-field" type="number" name="brock[espresso]" />
   </div>
 </div>

data/spec/fixtures/select_field.html

@@ -0,0 +1,20 @@
+<div class="control-group brock-field brock-field-select">
+  <div class="control-label">
+    Espresso
+  </div>
+
+  <div class="controls">
+    <label class="radio brock-label">
+      <input class="brock-field" type="radio" name="brock[espresso]" value="0" />
+      First
+
+      <p class="help-block">The first</p>
+    </label>
+    <label class="radio brock-label">
+      <input class="brock-field" type="radio" name="brock[espresso]" value="1" />
+      Second
+
+      <p class="help-block">The second</p>
+    </label>
+  </div>
+</div>

data/spec/fixtures/string_field.html

@@ -1,6 +1,6 @@
 <div class="control-group brock-field brock-field-string">
-  <label class="control-label brock-label">First name</label>
+  <label class="control-label brock-label">Espresso</label>
   <div class="controls">
-    <input class="brock-field" type="text" name="brock[first_name]" placeholder="Chris" value="5" />
+    <input class="brock-field" type="text" name="brock[espresso]" />
   </div>
 </div>

data/spec/fixtures/text_field.html

@@ -0,0 +1,6 @@
+<div class="control-group brock-field brock-field-text">
+  <label class="control-label brock-label">Espresso</label>
+  <div class="controls">
+    <textarea class="brock-field" name="brock[espresso]" /></textarea>
+  </div>
+</div>

data/spec/spec_helper.rb

@@ -1,22 +1,4 @@
-module FixtureHelpers
-
-  def fixture(path)
-    File.read(File.join(File.dirname(__FILE__), 'fixtures', path))
-  end
-
-end
-
-RSpec::Matchers.define :be_similar_to_fixture do |fixture_path|
-
-  def scrub(str)
-    str.gsub(/\s+/, ' ')
-  end
-
-  match do |actual|
-    scrub(actual) == scrub(fixture(fixture_path))
-  end
-
-end
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f }
 
 RSpec.configure do |config|
   config.include(FixtureHelpers)

data/spec/support/field_spec.rb

@@ -0,0 +1,35 @@
+require 'brock/field'
+
+shared_examples "a field" do
+
+  let(:default_fixture) { "#{described_class.type}_field.html" }
+
+  it "is a Brock::Field" do
+    expect(subject).to be_a(Brock::Field)
+  end
+
+  it ".type is a symbol" do
+    expect(described_class.type).to be_a(Symbol)
+  end
+
+  it '.detect with same type' do
+    expect(described_class.detect('type' => described_class.type.to_s))
+  end
+
+  it "#name is a symbol" do
+    expect(subject.name).to be_a(Symbol)
+  end
+
+  it "#label is optional" do
+    subject.instance_variable_set('@label', nil)
+    subject.stub(name: 'mp_tag')
+    expect(subject.label).to eq('Mp tag')
+  end
+
+  it "#to_html matches the fixture" do
+    scrubbed_html = scrub_html(subject.to_html)
+    scrubbed_fixture = scrub_html(fixture(default_fixture))
+    expect(scrubbed_html).to eq(scrubbed_fixture)
+  end
+
+end

data/spec/support/fixture_helpers.rb

@@ -0,0 +1,11 @@
+module FixtureHelpers
+
+  def scrub_html(str)
+    str.gsub(/\s+/, ' ')
+  end
+
+  def fixture(filename)
+    File.read(File.join(File.expand_path('../../fixtures', __FILE__), filename))
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brock
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,24 +58,33 @@ files:
 - lib/brock/field_template_context.rb
 - lib/brock/fields/boolean_field.rb
 - lib/brock/fields/integer_field.rb
+- lib/brock/fields/select_field.rb
 - lib/brock/fields/string_field.rb
+- lib/brock/fields/text_field.rb
 - lib/brock/schema.rb
 - lib/brock/version.rb
 - lib/brock.rb
 - share/boolean_field.erb
 - share/integer_field.erb
+- share/select_field.erb
 - share/string_field.erb
-- spec/brock/field_spec.rb
+- share/text_field.erb
 - spec/brock/field_template_context_spec.rb
 - spec/brock/field_template_spec.rb
 - spec/brock/fields/boolean_field_spec.rb
 - spec/brock/fields/integer_field_spec.rb
+- spec/brock/fields/select_field_spec.rb
 - spec/brock/fields/string_field_spec.rb
+- spec/brock/fields/text_field_spec.rb
 - spec/brock/schema_spec.rb
 - spec/fixtures/boolean_field.html
 - spec/fixtures/integer_field.html
+- spec/fixtures/select_field.html
 - spec/fixtures/string_field.html
+- spec/fixtures/text_field.html
 - spec/spec_helper.rb
+- spec/support/field_spec.rb
+- spec/support/fixture_helpers.rb
 homepage: https://minefold.com
 licenses: []
 post_install_message: 

data/spec/brock/field_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-require 'brock/field'
-
-describe Brock::Field do
-
-  subject {
-    described_class.new(
-      'type' => 'str',
-      'name' => 'a',
-      'label' => 'A',
-      'default' => 'a'
-    )
-  }
-
-  it "#type is a symbol" do
-    expect(subject.type).to be_a(Symbol)
-  end
-
-  it "#name is a symbol" do
-    expect(subject.type).to be_a(Symbol)
-  end
-
-  it "#parse_param raises by default" do
-    expect {
-      subject.parse_param(nil)
-    }.to raise_error(Brock::ParamParseError)
-  end
-
-end