RubyGems - brock - Versions diffs - 0.1.0 - Mend

brock 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

data/Gemfile +2 -0
data/README.md +41 -0
data/brock.gemspec +26 -0
data/lib/brock.rb +18 -0
data/lib/brock/definition.rb +54 -0
data/lib/brock/field.rb +34 -0
data/lib/brock/field_template.rb +34 -0
data/lib/brock/field_template_context.rb +24 -0
data/lib/brock/fields/boolean_field.rb +11 -0
data/lib/brock/fields/integer_field.rb +13 -0
data/lib/brock/fields/string_field.rb +11 -0
data/lib/brock/version.rb +3 -0
data/share/boolean_field.erb +13 -0
data/share/integer_field.erb +19 -0
data/share/string_field.erb +16 -0
data/spec/brock/definition_spec.rb +30 -0
data/spec/brock/field_spec.rb +29 -0
data/spec/brock/field_template_context_spec.rb +27 -0
data/spec/brock/field_template_spec.rb +31 -0
data/spec/brock/fields/boolean_field_spec.rb +34 -0
data/spec/brock/fields/integer_field_spec.rb +36 -0
data/spec/brock/fields/string_field_spec.rb +31 -0
data/spec/fixtures/boolean_field.html +8 -0
data/spec/fixtures/integer_field.html +6 -0
data/spec/fixtures/string_field.html +6 -0
data/spec/spec_helper.rb +24 -0
metadata +103 -0

data/Gemfile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ source 'https://rubygems.org'
2	+ gemspec

data/README.md ADDED Viewed

@@ -0,0 +1,41 @@
+# Brock
+![Brock](http://upload.wikimedia.org/wikipedia/en/7/71/DP-Brock.png)
+Generate HTML from definitions. Generate settings from params.
+    template = Brock.new([
+      { name: 'mp_maxrounds',
+        type: 'integer',
+        label: 'Max Round',
+        description: 'Maximum number of rounds to play',
+        default: 5
+      }
+    ])
+    template.to_html('mp_maxrounds' => 2) # => "<html>...</html>"
+    template.parse_params('mp_maxrounds' => 2) # => {'mp_maxrounds' => 10}
+## License
+The MIT License (MIT)
+Copyright © 2013 Mütli Corp. <tech+brock@minefold.com>
+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/brock.gemspec ADDED Viewed

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brock/version'
+Gem::Specification.new do |gem|
+  gem.name          = 'brock'
+  gem.version       = Brock::VERSION
+  gem.authors       = ["Dave Newman"]
+  gem.email         = ["dave@minefold.com"]
+  gem.description   = %q{Test Minefold funpacks}
+  gem.summary       = %q{Test Minefold funpacks}
+  gem.homepage      = "https://minefold.com"
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'nokogiri'
+  gem.files = %w(
+    Gemfile
+    README.md
+    brock.gemspec
+  ) + Dir['{lib,share,spec}/**/*']
+end

data/lib/brock.rb ADDED Viewed

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

data/lib/brock/definition.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require 'brock/fields/boolean_field'
+require 'brock/fields/integer_field'
+require 'brock/fields/string_field'
+module Brock
+  class FieldTypeNotSupported < StandardError
+  end
+  class Definition
+    attr_reader :fields
+    def self.field_for_type(type)
+      case type
+      when 'boolean'
+        BooleanField
+      when 'integer'
+        IntegerField
+      when 'string'
+        StringField
+      else
+        raise FieldTypeNotSupported
+      end
+    end
+    def initialize(definitions)
+      @fields = definitions.map do |definition|
+        klass = self.class.field_for_type(definition.fetch('type'))
+        klass.new(definition)
+      end
+    end
+    def to_html(values)
+      fields.map do |field|
+        field.to_html(values.fetch(field.name))
+      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)
+      end
+    end
+  # private
+    def field_with_name(name)
+      fields.find {|field| field.name == name.to_sym }
+    end
+  end
+end

data/lib/brock/field.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'brock/field_template'
+module Brock
+  class ParamParseError < ArgumentError
+  end
+  class Field
+    attr_reader :type
+    attr_reader :name
+    attr_reader :label
+    attr_reader :default
+    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')
+      @description = params['description']
+    end
+    def to_html(value=nil)
+      FieldTemplate.new(self).render(value)
+    end
+    def parse_param(value)
+      raise ParamParseError
+    end
+  end
+end

data/lib/brock/field_template.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'erb'
+require 'brock/field_template_context'
+module Brock
+  class FieldTemplate
+    def self.share_path
+      # __FILE__ is a special variable that is inlined at compile time so its value is this path to this file, not a subclasses'.
+      File.expand_path('../../../share', __FILE__)
+    end
+    attr_reader :field
+    def initialize(field)
+      @field = field
+    end
+    def render(value = nil)
+      ctx = FieldTemplateContext.new(@field, value)
+      ERB.new(raw).result(ctx.binding)
+    end
+  # private
+    def raw
+      File.read(path)
+    end
+    def path
+      File.join(self.class.share_path, "#{field.type}_field.erb")
+    end
+  end
+end

data/lib/brock/field_template_context.rb ADDED Viewed

@@ -0,0 +1,24 @@
+module Brock
+  class FieldTemplateContext
+    attr_reader :value
+    def initialize(field, value)
+      @field = field
+      @value = value
+    end
+    def binding
+      super
+    end
+    def method_missing(method, *args, &blk)
+      if @field and @field.respond_to?(method)
+        @field.send(method, *args, &blk)
+      else
+        super(*args, &blk)
+      end
+    end
+  end
+end

data/lib/brock/fields/boolean_field.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'brock/field'
+module Brock
+  class BooleanField < Field
+    def parse_param(value)
+      value == '1' || value == 'true' || value == true
+    end
+  end
+end

data/lib/brock/fields/integer_field.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'brock/field'
+module Brock
+  class IntegerField < Field
+    def parse_param(value)
+      Integer(value)
+    rescue ArgumentError
+      raise ParamParseError.new(value)
+    end
+  end
+end

data/lib/brock/fields/string_field.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'brock/field'
+module Brock
+  class StringField < Field
+    def parse_param(value)
+      value.to_s
+    end
+  end
+end

data/lib/brock/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Brock
+  VERSION = '0.1.0'
+end

data/share/boolean_field.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<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[<%= name %>]"
+             <% if value || default %>checked<% end %>
+      />
+      <%= label %>
+    </label>
+  </div>
+</div>

data/share/integer_field.erb ADDED Viewed

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

data/share/string_field.erb ADDED Viewed

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

data/spec/brock/definition_spec.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'brock/definition'
+describe Brock::Definition do
+  let(:data) {
+    [
+      {
+        "name" => "mp_maxrounds",
+        "type" => "integer",
+        "label" => "Max Rounds",
+        "description" => "Maximum number of rounds to play before server changes maps.",
+        "default" => 5
+      }, {
+        "name" => "mp_autoteambalance",
+        "type" => "boolean",
+        "label" => "Auto Team Balance",
+        "default" => true
+      }
+    ]
+  }
+  subject { described_class.new(data) }
+  it "initializes fields" do
+    expect { subject }.to_not raise_error(Brock::FieldTypeNotSupported)
+  end
+end

data/spec/brock/field_spec.rb ADDED Viewed

@@ -0,0 +1,29 @@
+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

data/spec/brock/field_template_context_spec.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'brock/field_template_context'
+describe Brock::FieldTemplateContext do
+  let(:field) { stub(name: 'field_name') }
+  subject { described_class.new(field, 5) }
+  it "delegates to the field" do
+    expect(subject.name).to eq('field_name')
+  end
+  it "has a value" do
+    expect(subject.value).to eq(5)
+  end
+  it "doesn't accidentally override the passed value" do
+    field.stub(:value) { 6 }
+    expect(subject.value).to eq(5)
+  end
+  it "#binding is public" do
+    expect(subject.binding).to be_a(Binding)
+  end
+end

data/spec/brock/field_template_spec.rb ADDED Viewed

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'brock/field_template'
+describe Brock::FieldTemplate do
+  let(:field) { stub }
+  subject { described_class.new(field) }
+  describe "#render" do
+    it "works" do
+      subject.stub(:raw) { 'My template' }
+      expect(subject.render).to eq('My template')
+    end
+    it "exposes field methods" do
+      field.stub(:name) { 'godmode' }
+      subject.stub(:raw) { '<%= name %>' }
+      expect(subject.render).to eq('godmode')
+    end
+  end
+  it "figures out the correct path" do
+    field.stub(type: 'string')
+    subject.class.stub(:share_path) { '/' }
+    expect(subject.path).to eq('/string_field.erb')
+  end
+end

data/spec/brock/fields/boolean_field_spec.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'spec_helper'
+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')
+  end
+  describe "#parse_param" do
+    it "works with 1" do
+      expect(subject.parse_param('1')).to eq(true)
+    end
+    it "works with true" do
+      expect(subject.parse_param('true')).to eq(true)
+    end
+    it "works with truthy-objects" do
+      expect(subject.parse_param(true)).to eq(true)
+    end
+  end
+end

data/spec/brock/fields/integer_field_spec.rb ADDED Viewed

@@ -0,0 +1,36 @@
+require 'spec_helper'
+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
+  describe "#parse_param" do
+    it "works with an integer" do
+      expect(subject.parse_param(10)).to eq(10)
+    end
+    it "works with an integer-like string" do
+      expect(subject.parse_param('10')).to eq(10)
+    end
+    it "raises with anything else" do
+      expect {
+        subject.parse_param('boom')
+      }.to raise_error(Brock::ParamParseError)
+    end
+  end
+end

data/spec/brock/fields/string_field_spec.rb ADDED Viewed

@@ -0,0 +1,31 @@
+require 'spec_helper'
+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')
+  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
+end

data/spec/fixtures/boolean_field.html ADDED Viewed

@@ -0,0 +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
+    </label>
+  </div>
+</div>

data/spec/fixtures/integer_field.html ADDED Viewed

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

data/spec/fixtures/string_field.html ADDED Viewed

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

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,24 @@
+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
+RSpec.configure do |config|
+  config.include(FixtureHelpers)
+  config.order = 'random'
+end

metadata ADDED Viewed

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: brock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease:
+platform: ruby
+authors:
+- Dave Newman
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-01-15 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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: Test Minefold funpacks
+email:
+- dave@minefold.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- brock.gemspec
+- lib/brock/definition.rb
+- lib/brock/field.rb
+- lib/brock/field_template.rb
+- lib/brock/field_template_context.rb
+- lib/brock/fields/boolean_field.rb
+- lib/brock/fields/integer_field.rb
+- lib/brock/fields/string_field.rb
+- lib/brock/version.rb
+- lib/brock.rb
+- share/boolean_field.erb
+- share/integer_field.erb
+- share/string_field.erb
+- spec/brock/definition_spec.rb
+- spec/brock/field_spec.rb
+- 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/string_field_spec.rb
+- spec/fixtures/boolean_field.html
+- spec/fixtures/integer_field.html
+- spec/fixtures/string_field.html
+- spec/spec_helper.rb
+homepage: https://minefold.com
+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:
+rubygems_version: 1.8.23
+signing_key:
+specification_version: 3
+summary: Test Minefold funpacks
+test_files: []