form_object 0.0.1

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Vim
+.*.sw[a-z]
+*.un~
+Session.vim
+.netrwhist
+
+# OSX
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in form_object.gemspec
+gemspec
+
+gem 'rake'
+gem 'minitest'
+gem 'turn'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kirillov Alexander
+
+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,32 @@
+# FormObject
+
+[![Build Status](https://travis-ci.org/saratovsource/form_object.png)](https://travis-ci.org/saratovsource/form_object)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/saratovsource/form_object)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'form_object'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install form_object
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/lib/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/TODO

@@ -0,0 +1,15 @@
+Features list
+
+* Features
+  - Model:
+    - Get the FormObject with filled attributes
+    - Forms collection for retrive named form
+  - FormObject:
+    - Get the model with filled attributes
+    - Create builder for markup (form_for, simple_form_for, etc...)
+
+* Integrations
+  - ActiveRecord
+  - Mongoid
+  - DataMapper 1.x
+  - DataMapper 2.x

data/form_object.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'form_object/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "form_object"
+  gem.version       = FormObject::VERSION
+  gem.authors       = ["Kirillov Alexander"]
+  gem.email         = ["saratovsource@gmail.com"]
+  gem.description   = "Form objects for ruby on rails applications."
+  gem.summary       = "Form object implementation"
+
+  gem.rubyforge_project = "form_object"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'virtus'
+  gem.add_dependency 'activemodel'
+end

data/lib/form_object.rb

@@ -0,0 +1,9 @@
+require "form_object/version"
+require 'virtus'
+require 'active_model'
+
+module FormObject
+  autoload :Base, 'form_object/base'
+  autoload :Integrations, 'form_object/integrations'
+  # Your code goes here...
+end

data/lib/form_object/base.rb

@@ -0,0 +1,16 @@
+module FormObject
+  class Base
+    include Virtus
+
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    # Forms are never themselves persisted
+    def persisted?; false; end  
+
+    def model
+      nil
+    end
+  end
+end

data/lib/form_object/integrations.rb

@@ -0,0 +1,43 @@
+require 'form_object/integrations/base'
+Dir["#{File.dirname(__FILE__)}/integrations/*.rb"].sort.each do |path|
+  require "form_object/integrations/#{File.basename(path)}"
+end
+
+module FormObject
+  # Invalid integration error
+  class IntegrationNotFound < StandardError
+    def initialize( name )
+      super "#{name.inspect} is invalid integration"
+    end
+  end
+
+  module Integrations
+
+    # Get collection of all integrations
+    # ActiveModel must be last always
+    # == Example
+    #
+    #  Object::Integrations.all
+    #  # => [FormObject::Integrations::ActiveRecord]
+    #
+    def self.all
+      constants = self.constants.map{ |c| c.to_s }
+                                .select{ |c| c!= 'ActiveModel' }
+                                .sort << 'ActiveModel'
+      constants.map{ |c| const_get(c) }
+    end
+
+    # Find integration by name
+    # 
+    # == Examples
+    #   FormObject::Integrations.find(:active_record) # => FormObject::Integrations::ActiveRecord
+    #
+    def self.find( name )
+      all.detect {|i| i.integration_name == name} || raise(IntegrationNotFound.new(name))
+    end
+
+    def self.match( *args )
+      all.detect {|i| i.matches_ancestors?(args)}
+    end
+  end
+end

data/lib/form_object/integrations/active_model.rb

@@ -0,0 +1,12 @@
+module FormObject
+  module Integrations
+    module ActiveModel
+      include Base
+
+      def self.matching_ancestors
+        %w(ActiveModel ActiveModel::Observing ActiveModel::Validations)
+      end
+
+    end
+  end
+end

data/lib/form_object/integrations/active_record.rb

@@ -0,0 +1,12 @@
+module FormObject
+  module Integrations
+    module ActiveRecord
+      include Base
+      
+      def self.matching_ancestors
+        %w(ActiveRecord::Base)
+      end
+
+    end
+  end
+end

data/lib/form_object/integrations/base.rb

@@ -0,0 +1,111 @@
+module FormObject
+  module Integrations
+    module Base
+      module ClassMethods
+        # The default options to use for state machines using this integration
+        attr_reader :defaults
+        
+        # FormsCollection for this model
+        #
+        # == Example
+        #
+        #   class BaseForm < FormObject::Base
+        #     model User
+        #   end
+        #
+        #   class TwitterForm < FormObject::Base
+        #     model User, as: :twitter
+        #   end
+        #
+        #   @user = User.new
+        #   @base_form = @user.forms[:base]       # => instance of BaseForm
+        #   @twitter_form = @iser.forms[:twitter] # => instance of TwitterForm
+        #
+        # Forms must have names. If the form name is not specified, it is taken
+        # from class name.
+        def forms
+          nil
+        end
+
+        # The name of the integration
+        def integration_name
+          @integration_name ||= begin
+            name = self.name.split('::').last
+            name.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            name.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+            name.downcase!
+            name.to_sym
+          end
+        end
+        
+        # Whether this integration is available for the current library.  This
+        # is only true if the ORM that the integration is for is currently
+        # defined.
+        def available?
+          matching_ancestors.any? && Object.const_defined?(matching_ancestors[0].split('::')[0])
+        end
+        
+        # The list of ancestor names that cause this integration to matched.
+        def matching_ancestors
+          []
+        end
+
+        # Whether the integration should be used for the given class.
+        def matches?(klasses)
+          ancestor_names = klasses.map {|klass| klass.ancestors.map(&:name)}
+          matches_ancestors?(ancestor_names)
+        end
+
+        # Whether the integration should be used for the given list of ancestors.
+        def matches_ancestors?(ancestors)
+          (ancestors & matching_ancestors).any?
+        end
+
+        # The path to the locale file containing translations for this
+        # integration.  This file will only exist for integrations that actually
+        # support i18n.
+        def locale_path
+          path = "#{File.dirname(__FILE__)}/#{integration_name}/locale.rb"
+          path if File.exists?(path)
+        end
+
+        # Extends the given object with any version overrides that are currently 
+        # active
+        def extended(base)
+          versions.each do |version|
+             base.extend(version) if version.active?
+          end
+        end
+
+        # Defined versions
+        def versions
+          @versions ||= []
+        end
+
+        # DSL for define version and version based methods
+        #
+        def version( name, &block )
+          mod = Module.new(&block)
+          versions << mod
+          mod
+        end
+
+      end
+
+      extend ClassMethods
+    
+      module InstanceMethods
+
+        # FormsCollection for this model
+        def forms
+          self.class.forms
+        end
+      end
+    
+      def self.included(receiver) #:nodoc:
+        receiver.extend         ClassMethods
+        receiver.send :include, InstanceMethods
+      end
+    end
+  end
+end

data/lib/form_object/version.rb

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

data/test/lib/form_object_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class FormObjectTest < TestCase
+  def setup
+    @form = Filter.new(query: "find me")
+  end
+
+  def test_should_form_not_persisted
+    assert !@form.persisted?
+  end
+
+  def test_form_should_have_query_attribute
+    assert "find me", @form.query
+  end
+
+  def test_should_be_valid_form
+    assert @form.valid?
+  end
+
+  def test_should_be_invalid_with_empty_query
+    @form.query = ""
+    assert !@form.valid?
+  end
+
+  def test_should_have_not_nil_created_at_attribute
+    assert @form.created_at.kind_of?(DateTime)
+    assert @form.created_at.present?
+  end
+
+end

data/test/lib/form_relation_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class FormRelationTest < TestCase
+  def setup
+    @form = Filter.new(query: "find me")
+  end
+
+  def test_should_not_form_get_model
+    assert_respond_to @form, :model
+    assert @form.model.nil?
+  end
+end

data/test/lib/forms_collection_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class FormsCollectionTest < TestCase
+  def setup
+    @form = Filter.new(query: "find me")
+  end
+
+  def test_should_model_have_forms_collection
+    
+  end
+end

data/test/lib/integrations/base_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module Integrations
+
+  class BaseTest < ::TestCase
+
+    def setup
+      superclass = Class.new
+      self.class.const_set('Vehicle', superclass)
+      
+      @klass = Class.new(superclass)
+    end
+
+    def test_should_return_nil_if_match_not_found
+      assert_nil FormObject::Integrations.match(@klass)
+    end
+
+  end
+end

data/test/support/filter.rb

@@ -0,0 +1,6 @@
+class Filter < FormObject::Base
+  attribute :query, String
+  attribute :created_at, DateTime, default: Proc.new{ DateTime.now }
+
+  validates :query, presence: true
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.require
+require 'minitest/autorun'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+MiniTest::Unit.autorun
+
+class TestCase < MiniTest::Unit::TestCase
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: form_object
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kirillov Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-19 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: Form objects for ruby on rails applications.
+email:
+- saratovsource@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- form_object.gemspec
+- lib/form_object.rb
+- lib/form_object/base.rb
+- lib/form_object/integrations.rb
+- lib/form_object/integrations/active_model.rb
+- lib/form_object/integrations/active_record.rb
+- lib/form_object/integrations/base.rb
+- lib/form_object/version.rb
+- test/lib/form_object_test.rb
+- test/lib/form_relation_test.rb
+- test/lib/forms_collection_test.rb
+- test/lib/integrations/base_test.rb
+- test/support/filter.rb
+- test/support/model.rb
+- test/test_helper.rb
+homepage: 
+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'
+      segments:
+      - 0
+      hash: -476988463
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -476988463
+requirements: []
+rubyforge_project: form_object
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Form object implementation
+test_files:
+- test/lib/form_object_test.rb
+- test/lib/form_relation_test.rb
+- test/lib/forms_collection_test.rb
+- test/lib/integrations/base_test.rb
+- test/support/filter.rb
+- test/support/model.rb
+- test/test_helper.rb