cave 0.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,66 @@
+Cave
+=====
+
+A simple Ruby form library, intended for use with Rails
+
+Largely inspired by Code Climate's [7 Patterns to Refactor Fat ActiveRecord Models](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/) as a method for encapsulating validation into an object with a single responsibility.
+
+### Forms
+
+[Cave::Form](https://github.com/jamesdabbs/cave/blob/master/lib/cave/form.rb) is a light glue layer around 
+[Rails' ActiveModel::Validations](http://guides.rubyonrails.org/active_record_validations_callbacks.html) 
+and [Virtus](https://github.com/solnic/virtus)' type coercion. You may want to consult their documentation for
+more options.
+
+    class FormClass < Cave::Form
+      field :name, String,
+        presence: true,
+        format: { :with => /\A[a-zA-Z]+\z/, :message => "Only letters allowed" }
+        # Takes any number of standard Rails validation helper options
+      field :favorite_number, Integer,
+        inclusion: { :in => 1..10 }
+
+      def persist!
+        # Define your persistence logic here.
+        # This method will be called whenever a valid form is saved.
+        "Form saved!"
+      end
+    end
+
+    form = FormClass.bind name: 'James Dabbs', favorite_number: 11
+    form.valid?
+    => false
+    form.errors.full_messages
+    => ["Name Only letters allowed", "Favorite number is not included in the list"]
+
+    form = FormClass.bind name: 'jamesdabbs', favorite_number: '7'
+    form.valid?
+    => true
+    form.favorite_number
+    => 7  // Note the type coercion
+    form.save!
+    => "Form saved!"
+
+###Forms for Models
+
+For the common use case of creating or updating a model with a form, Cave provides
+the [Cave::ModelForm](https://github.com/jamesdabbs/cave/blob/master/lib/cave/model_form.rb) class.
+
+    class ProfileForm < Cave::ModelForm
+      model Profile
+
+      field :name, String, presence: true
+      field :age,  Integer
+    end
+
+    ProfileForm.bind(name: 'James').save!  # Creates a new Profile named 'James'
+
+    instance = Profile.first
+    ProfileForm.bind(instance, name: 'Jim').save!  # Updates the Profile's name
+
+###Planned features
+
+- Add presenters for rendering forms into html (inc. a bootstrap template)
+- Improve handling of intial values (as for unbound ModelForms)
+- Write docs
+- Requests?

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/cave.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'cave'
+  s.version     = '0.0.1'
+  s.date        = '2013-01-31'
+  s.summary     = 'A simple Ruby form library, intended for use with Rails'
+  s.description = 'Cave Forms encapsulate validation logic into an object with that single responsibility'
+  s.authors     = ['James Dabbs']
+  s.email       = 'jamesdabbs@gmail.com'
+  s.files       = %w{ Gemfile Rakefile README.md cave.gemspec }
+  s.files      += Dir['lib/**/*.rb']
+  s.test_files  = Dir['spec/**/*.rb']
+  s.homepage    = 'http://github.com/jamesdabbs/cave'
+
+  s.add_dependency 'activemodel'
+  s.add_dependency 'virtus'
+end

data/lib/cave.rb

@@ -0,0 +1,6 @@
+require 'cave/errors'
+require 'cave/form'
+require 'cave/model_form'
+
+module Cave
+end

data/lib/cave/errors.rb

@@ -0,0 +1,4 @@
+module Cave
+  class ValidationError < Exception
+  end
+end

data/lib/cave/form.rb

@@ -0,0 +1,75 @@
+require 'active_model'
+require 'virtus'
+
+module Cave
+  class Form
+    include Virtus
+    include ActiveModel::Validations
+
+    class << self
+
+      def fields
+        @_fields ||= {}
+      end
+
+      def field name, type, opts={}
+        @_fields ||= {}
+        @_fields[name] = type
+
+        attribute name, type
+
+        opts.each do |k,v|
+          validates name, {k => v}
+        end
+      end
+
+      def bind *args
+        f = new *args
+        f.instance_eval { @bound = true }
+        f
+      end
+
+    end
+
+    validate :field_coercion
+
+    def initialize attrs={}
+      super
+      bind attrs unless attrs.empty?
+    end
+
+    def bind attrs={}
+      self.attributes = (attributes || {}).merge attrs
+      @bound = true
+    end
+
+    def bound?
+      @bound
+    end
+
+    def unbound?
+      !@bound
+    end
+
+    def save!
+      raise Cave::ValidationError.new errors.full_messages.join(',') unless valid?
+      persist!
+    end
+
+    def persist!
+      raise "#{self.class} does not define a persist method"
+    end
+
+    private #----------
+
+    def field_coercion
+      self.class.fields.each do |name, type|
+        value = attributes[name]
+        unless value.nil? || value.is_a?(type)
+          errors.add name, "should be a(n) #{type}"
+        end
+      end
+    end
+
+  end
+end

data/lib/cave/model_form.rb

@@ -0,0 +1,37 @@
+module Cave
+  class ModelForm < Form
+    def self.model klass=nil
+      @@model ||= klass
+    end
+
+    def initialize instance=nil, attrs={}
+      (instance, attrs = nil, instance) if instance.is_a? Hash
+      super attrs
+      self.for instance
+    end
+
+    def for instance
+      @instance = instance
+      check_instance_model
+    end
+
+    def persist!
+      if @instance
+        @instance.update_attributes attributes
+      else
+        @instance = self.class.model.create! attributes
+      end
+    end
+
+    private #-----------
+
+    def check_instance_model
+      model = self.class.model
+      if @instance
+        raise TypeError.new("Instance #{@instance} is not a #{model}") unless @instance.is_a? model
+      else
+        raise TypeError.new("Please specify a model class to create") unless model.is_a? Class
+      end
+    end
+  end
+end

data/spec/gears/form_spec.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+class ExampleForm < Cave::Form
+  field :name, String,  presence: true
+  field :age,  Integer
+end
+
+describe ExampleForm do
+  context 'when unbound' do
+    subject { ExampleForm.new }
+
+    it { should_not be_bound }
+    it { should_not be_valid }
+  end
+
+  context 'when bound' do
+    subject { ExampleForm.bind name: 'James', age: 26 }
+
+    it { should be_bound }
+    its(:name) { should == 'James' }
+
+    it 'validates name' do
+      subject.name = ''
+      subject.should_not be_valid
+    end
+
+    it 'coerces age' do
+      subject.age = '27'
+      subject.age.should be 27
+    end
+
+    it 'fails on uncoercible ages' do
+      subject.age = 'invalid'
+      subject.should_not be_valid
+    end
+
+    it 'allows uncoerced nils' do
+      subject.age = nil
+      subject.should be_valid
+    end
+  end
+
+  context 'when bound with no data' do
+    subject { ExampleForm.bind }
+
+    it { should be_bound }
+  end
+
+  context 'when valid' do
+    subject { ExampleForm.bind name: 'James', age: 26 }
+
+    it { should be_valid }
+
+    it 'has no errors' do
+      subject.valid?
+      subject.errors.should be_empty
+    end
+
+    it 'can be saved' do
+      subject.should_receive :persist!
+      subject.save!
+    end
+  end
+
+  context 'when invalid' do
+    let(:form) { ExampleForm.bind }
+
+    it 'has errors' do
+      subject.valid?
+      subject.errors.should be_present
+    end
+
+    it 'cannot be saved' do
+      expect { subject.save! }.to raise_error Cave::ValidationError
+    end
+  end
+end

data/spec/gears/model_form_spec.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class Profile < OpenStruct
+  def create! attrs; end
+  def update_attributes attrs; end
+end
+
+class ExampleModelForm < Cave::ModelForm
+  model Profile
+
+  field :name, String
+end
+
+describe ExampleModelForm do
+
+  it 'checks instance against model' do
+    expect { ExampleModelForm.new 1 }.to raise_error TypeError
+  end
+
+  context 'when new' do
+    subject { ExampleModelForm.new name: 'James' }
+
+    it 'creates' do
+      Profile.should_receive :create!
+      subject.save!
+    end
+  end
+
+  context 'pre-existing' do
+    let(:instance) { Profile.new name: 'James' }
+    subject { ExampleModelForm.new instance, name: 'Jim' }
+
+    it 'updates' do
+      instance.should_receive(:update_attributes).with(name: 'Jim')
+      subject.save!
+    end
+
+    it 'does not create' do
+      Profile.should_not_receive :create!
+      subject.save!
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'cave'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cave
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Dabbs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cave Forms encapsulate validation logic into an object with that single
+  responsibility
+email: jamesdabbs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- README.md
+- cave.gemspec
+- lib/cave/errors.rb
+- lib/cave/form.rb
+- lib/cave/model_form.rb
+- lib/cave.rb
+- spec/gears/form_spec.rb
+- spec/gears/model_form_spec.rb
+- spec/helper.rb
+homepage: http://github.com/jamesdabbs/cave
+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.24
+signing_key: 
+specification_version: 3
+summary: A simple Ruby form library, intended for use with Rails
+test_files:
+- spec/gears/form_spec.rb
+- spec/gears/model_form_spec.rb
+- spec/helper.rb