dyna_form 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebe2e3f52047f575f890cb82eac1285e34c80d6f
+  data.tar.gz: 307dd2232cbfda97c6ef3dbe723f57135b697a8a
+SHA512:
+  metadata.gz: ccbbb29668da0e8dae6fbeeed2522157d6193ae10935409a11f33c327a61689e32d4d8f68a353de4ac9c512f83e6d56e68c87cf97538010cb9ec45b65ced66c0
+  data.tar.gz: 00400aba310c964d9269fe2bb7bc6ca2359f26701c14406fece26fa7f4251fa569b088409d785aa649e2d2c35fe45961be114c46c152fd0d68a264820dcae8cd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dyna_form.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    dyna_form (0.1.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+    activerecord (4.1.4)
+      activemodel (= 4.1.4)
+      activesupport (= 4.1.4)
+      arel (~> 5.0.0)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.6.11)
+    json (1.8.1)
+    minitest (5.4.0)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  dyna_form!
+  rake
+  rspec (~> 3.0.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Willux
+
+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,90 @@
+# DynaForm
+
+* Delegate all your forms to given models. 
+* Create multiple entries through a single form without a need for nesting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dyna_form'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dyna_form
+
+## Usage
+
+If you are using Ruby on Rails, I suggest you create a `app/forms` folder. This way you can keep your form submission functionality separate from the rest of the code.
+
+Create a class that extends `DynaForm::Base`:
+
+```ruby
+class TestForm < DynaForm::Base
+  # TODO: Put code here
+end
+```
+
+Now suppose `:first_name` and `:last_name` belong in the `User` model, while
+`address` belongs in the `Address` model. You can create a form in the following
+way:
+```ruby
+form_for @user do |f|
+  f.input :first_name
+  f.input :last_name
+  f.fields_for :address do |a|
+    a.input :address
+```
+
+This is just a simple example. The form can get much more complicated and more
+nested. **It can get really ugly really fast**
+
+Now suppose we have our `TestForm` like so:
+
+```ruby
+class TestForm < DynaForm::Base
+  submit :first_name, :last_name, to: User
+  submit :address, to: Address
+end
+```
+
+In the controller you can create a form object to pass in to the view:
+
+```ruby
+@test_form = TestForm.new
+```
+
+Then in your view you can use the object and create any fields you want:
+```ruby
+form_for @test_form do |f|
+  f.input :first_name
+  f.input :last_name
+  f.input :address
+end
+```
+
+Once all the form values are passed, you can create the object with the params:
+```ruby
+@test_form = TestForm.new(params)
+```
+
+and submit it:
+
+```ruby
+@test_form.submit!
+```
+
+`DynaForm#submit!` calls `ActiveRecord::Base#create!`. Which means that whatever
+exception `ActiveRecord::Base#create!` throws, `DynaForm#submit!` will throw.
+
+## Contributing
+
+1. Fork it ( https://github.com/willux/dyna_form/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/dyna_form.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dyna_form/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dyna_form"
+  spec.version       = DynaForm::VERSION
+  spec.authors       = ["Willux"]
+  spec.email         = ["zaikaus1@gmail.com"]
+  spec.summary       = %q{A gem used to help delegate form fields to their respective models.}
+  spec.description   = %q{We want to avoid nested forms while creating a form based on some object. This will help keep the forms clean while easily delegating each field into their models.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/lib/dyna_form/base.rb

@@ -0,0 +1,97 @@
+module DynaForm
+  class Base
+    extend ActiveModel::Naming
+    extend DynaForm::Constants
+
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+
+    class << self
+      def submit(*args, hash)
+        updated_hsh = hash.with_indifferent_access
+        unless updated_hsh.length == SUBMIT_HASH_LIMIT && updated_hsh.has_key?(:to)
+          raise "Invalid parameter list." 
+        end
+
+        raw_model = updated_hsh[:to].to_s
+        words = raw_model.split("_")
+        model_name = words.map { |w| w[0..0].capitalize + w[1..-1] }.join("")
+        
+        fields =  begin
+                    class_variable_get(:@@fields)
+                  rescue NameError
+                    class_variable_set(:@@fields, {})
+                    {}
+                  end
+
+        fields[model_name] ||= []
+        fields[model_name] += args
+        class_variable_set(:@@fields, fields)
+      end
+    end
+
+    def initialize(args = {})
+      @lazy_initialization = (args == {})
+      args.each do |key, val|
+        create_var(key, val)
+      end
+    end
+
+    def method_missing(method, *arguments, &block)
+      @lazy_initialization ? create_var(method, arguments.first) : super
+    end
+
+    def submit!
+      submissions.each { |s| s.submit! }
+    end
+
+    def submit
+      submissions.each { |s| s.submit }
+    end
+
+    def persisted?
+      false
+    end
+
+    protected
+
+    def submissions
+      return @submissions unless @submissions.nil?
+
+      @submissions = []
+
+      # TODO: we might be able to change this to just @@fields. More testing
+      # will be required to ensure that that is the case.
+      fields = self.class.class_variable_get(:@@fields)
+      fields.each do |model, variables|
+        @submissions << DynaForm::Submission.new(model, variables, attributes)
+      end
+      @submissions
+    end
+
+    def attributes
+      return @attributes unless @attributes.nil?
+
+      @attributes = {}
+      instance_variables.each do |var|
+        attribute = var.to_s[1..-1].to_sym
+        @attributes[attribute] = instance_variable_get(var)
+      end
+      @attributes
+    end
+
+    def create_var(var_name, var_value)
+      updated_var_name =  if var_name[-1, 1] == '='
+                            var_name[0...-1]
+                          else
+                            var_name
+                          end
+
+      self.instance_variable_set("@#{updated_var_name}", var_value)
+
+      self.class.instance_eval do
+        attr_accessor "#{updated_var_name}"
+      end
+    end
+  end
+end

data/lib/dyna_form/constants.rb

@@ -0,0 +1,5 @@
+module DynaForm
+  module Constants
+    SUBMIT_HASH_LIMIT = 1
+  end
+end

data/lib/dyna_form/submission.rb

@@ -0,0 +1,33 @@
+module DynaForm
+  class Submission
+
+    def initialize(model, variables, attributes)
+      @model = parse_model(model)
+      @variables = variables.map(&:to_sym)
+      @attributes = attributes.clone
+    end    
+
+    def submit!
+      submit_helper(true)
+    end
+
+    def submit
+      submit_helper(false)
+    end
+
+    private
+
+    def submit_helper(dangerous)
+      attrs = @attributes.select { |k, _| @variables.include?(k.to_sym) }
+
+      class_name = @model
+      dangerous ? Kernel.const_get(class_name).create!(attrs) : Kernel.const_get(class_name).create(attrs)  
+    end
+
+    def parse_model(model)
+      str_model = model.to_s
+      words = str_model.split("_")
+      words.map { |w| w[0..0].capitalize + w[1..-1] }.join("")
+    end
+  end
+end

data/lib/dyna_form/version.rb

@@ -0,0 +1,3 @@
+module DynaForm
+  VERSION = "0.1.0"
+end

data/lib/dyna_form.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require "dyna_form/version"
+require "dyna_form/constants"
+require "dyna_form/submission"
+require "dyna_form/base"

data/spec/dyna_form/base_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe DynaForm::Base do
+  describe ".new" do
+    let(:base) { DynaForm::Base.new(var: "good", life: 42, "foo" => :bar)}
+
+    it "should create instance variables based on the arguments" do
+      expect(base.var).to eq("good")
+      expect(base.life).to eq(42)
+      expect(base.foo).to eq(:bar)
+    end
+
+    context "given that the argument hash is not empty" do
+      it "should not allow to initialize another instance variable" do
+        expect { base.new_var = "good" }.to raise_error(NoMethodError)
+      end
+    end
+
+    context "given that the argument has is empty" do
+      it "should allow to initialize any other instance variables" do
+        empty_base = DynaForm::Base.new
+        empty_base.new_var = :foo
+        empty_base.new_var_again = 42
+
+        expect(empty_base.new_var).to eq(:foo)
+        expect(empty_base.new_var_again).to eq(42)
+      end
+    end
+  end
+
+  describe ".submit" do
+    it "should return the fields associated with a given class" do
+      fields = TestForm.class_variable_get(:@@fields)
+      expect(fields).to have_key("AdminUser")
+      expect(fields).to have_key("Nobody")
+
+      expect(fields["AdminUser"] - [:first_name, :last_name]).to eq([])
+      expect(fields["Nobody"] - [:who_cares]).to eq([])
+    end
+
+    context "given that the same model is used in different instances" do
+      it "should merge the fields of the same model" do
+        fields = TestFormAgain.class_variable_get(:@@fields)
+        expect(fields).to have_key("AdminUser")
+
+        expect(fields["AdminUser"] - [:middle_name, :nickname, :permissions, :awesomness]).to eq([])
+      end
+    end
+  end
+end

data/spec/dyna_form/submission_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe DynaForm::Submission do
+  describe "#submit" do
+    let (:hypo_object) { OpenStruct.new }
+    let (:variables) { [:first_name, :last_name] }
+    let (:too_many_vars) { [:first_name, :last_name, :foo, :bar] }
+    let (:attributes) { { :first_name => "Who", :last_name => "Cares", :foo => 42 } }
+
+    context "given the model is in underscore style symbol" do
+      it "should be able to properly parse the model name" do
+        expect(Kernel).to receive(:const_get).with("AdminUser").and_raise("User created")
+        submission = DynaForm::Submission.new(:admin_user, variables, attributes)
+        expect { submission.submit }.to raise_error("User created")
+      end
+    end
+
+    context "given the model is in underscore style string" do
+      it "should be able to properly parse the model name" do
+        expect(Kernel).to receive(:const_get).with("AdminUser").and_raise("User created")
+        submission = DynaForm::Submission.new("admin_user", variables, attributes)
+        expect { submission.submit }.to raise_error("User created")
+      end
+    end
+
+    context "given the model is in camelcase style string" do
+      it "should be able to properly parse the model name" do
+        expect(Kernel).to receive(:const_get).with("AdminUser").and_raise("User created")
+        submission = DynaForm::Submission.new("adminUser", variables, attributes)
+        expect { submission.submit }.to raise_error("User created")
+      end
+    end
+
+    context "given the model is in upper camelcase style string" do
+      it "should be able to properly parse the model name" do
+        expect(Kernel).to receive(:const_get).with("AdminUser").and_raise("User created")
+        submission = DynaForm::Submission.new("AdminUser", variables, attributes)
+        expect { submission.submit }.to raise_error("User created")
+      end
+    end
+
+    context "given the variables we want to save" do
+      it "should pick out the attributes based on the variable names" do
+        attrs = { :first_name => "Who", :last_name => "Cares" }
+
+        expect(Kernel).to receive(:const_get).with("AdminUser").and_return(hypo_object)
+        expect(hypo_object).to receive(:create).with(attrs).and_raise("User created")
+
+        submission = DynaForm::Submission.new(AdminUser, variables, attributes)
+        expect { submission.submit }.to raise_error("User created")
+      end      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'active_support/all'
+require 'dyna_form' # and any other gems you need
+require 'support/admin_user'
+require 'support/test_form'
+require 'support/test_form_again'
+require 'ostruct'
+
+RSpec.configure do |config|
+  # some (optional) config here
+  # end
+end

data/spec/support/admin_user.rb

@@ -0,0 +1,3 @@
+class AdminUser
+  attr_accessor :first_name, :last_name
+end

data/spec/support/test_form.rb

@@ -0,0 +1,4 @@
+class TestForm < DynaForm::Base
+  submit :first_name, :last_name, :to => AdminUser
+  submit :who_cares, :to => "nobody"
+end

data/spec/support/test_form_again.rb

@@ -0,0 +1,4 @@
+class TestFormAgain < DynaForm::Base
+  submit :middle_name, :nickname, :to => AdminUser
+  submit :permissions, :awesomness, :to => AdminUser
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: dyna_form
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Willux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: We want to avoid nested forms while creating a form based on some object.
+  This will help keep the forms clean while easily delegating each field into their
+  models.
+email:
+- zaikaus1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- dyna_form.gemspec
+- lib/dyna_form.rb
+- lib/dyna_form/base.rb
+- lib/dyna_form/constants.rb
+- lib/dyna_form/submission.rb
+- lib/dyna_form/version.rb
+- spec/dyna_form/base_spec.rb
+- spec/dyna_form/submission_spec.rb
+- spec/spec_helper.rb
+- spec/support/admin_user.rb
+- spec/support/test_form.rb
+- spec/support/test_form_again.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A gem used to help delegate form fields to their respective models.
+test_files:
+- spec/dyna_form/base_spec.rb
+- spec/dyna_form/submission_spec.rb
+- spec/spec_helper.rb
+- spec/support/admin_user.rb
+- spec/support/test_form.rb
+- spec/support/test_form_again.rb