dynamic_attribute_declaration 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ad3c08b64a3d53dcc5fd27e5896cb071bb50823
+  data.tar.gz: 8ff5b41d713eb37669edc7f22315fb83050c71bf
+SHA512:
+  metadata.gz: 1881cac321ff34eb75ab1d203f789d5e198f63bed0b31e33e2e4d33ce7625ce58cf37dab8aed481f89741288e9640798ee109ae1da1728bb4152474d8ba57e98
+  data.tar.gz: 8fcb16e746e38c1fa01a5cf9ec75de1055ec2e7eb0c31cb0ff151dc8623906850867345cf77084117f8471b104af693dee1c9fc8d7d2df508c781518112db890

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,3 @@
+--require spec_helper
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p481

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mikkel Wied Frederiksen
+
+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,29 @@
+# DynamicAttributeDeclaration
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dynamic_attribute_declaration'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynamic_attribute_declaration
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dynamic_attribute_declaration/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/dynamic_attribute_declaration.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dynamic_attribute_declaration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynamic_attribute_declaration"
+  spec.version       = DynamicAttributeDeclaration::VERSION
+  spec.authors       = ["Mikkel Wied Frederiksen"]
+  spec.email         = ["mikkel@wied.cc"]
+  spec.summary       = %q{This gem lets you dynamically declare validations, that can function as partly applied validation, based on some kind of model instance state.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency('database_cleaner')
+
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+end

data/lib/dynamic_attribute_declaration.rb

@@ -0,0 +1,89 @@
+require "dynamic_attribute_declaration/version"
+
+module DynamicAttributeDeclaration
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :_dynamic_attrs
+    class_attribute :_dynamic_attr_state_if
+    self._dynamic_attrs = {}
+    self._dynamic_attr_state_if = Proc.new { false }
+  end
+
+  def values_for attr_name
+    _dynamic_attrs[attr_name][:values] if _dynamic_attrs.key?(attr_name) && _dynamic_attrs[attr_name].key?(:values)
+  end
+
+  module ClassMethods
+
+    def inherited(base) #:nodoc:
+      dup = _dynamic_attrs.dup
+      base._dynamic_attrs = dup.each { |k, v| dup[k] = v.dup }
+      base._dynamic_attr_state_if = nil
+      super
+    end
+
+    def clear_dynamic_attrs!
+      self._dynamic_attrs = {}
+      self._dynamic_attr_state_if = nil
+    end
+
+    def define_attr_state_if proc
+      throw "define_attr_state_if should be a proc" unless proc.class == Proc
+      self._dynamic_attr_state_if = proc
+    end
+
+    def define_attrs *args
+      attrs = Hash[*args.flatten]
+      self._dynamic_attrs.merge! attrs
+      build_validations_from_dynamic_attrs attrs
+    end
+
+    def attrs_for state=nil, device=nil
+      if state
+        device ||= :desktop
+        _dynamic_attrs.select do |key, val|
+          if val.class == Symbol
+            comparer = val
+          elsif val.respond_to?(:key) && val.key?(:on)
+            comparer = val[:on] if val[:on].class == Symbol
+            comparer = val[:on][device.to_sym] if val[:on].respond_to?(:key) && val[:on].key?(device.to_sym)
+          end
+
+          [*comparer].map(&:to_sym).include? state.to_sym
+        end
+      else
+        _dynamic_attrs
+      end
+    end
+
+    def attrs_names_for state=nil, device=nil
+      attrs_for(state, device).map(&:first)
+    end
+
+    def build_validations_from_dynamic_attrs attrs
+      # throw "No validation state if defined" unless _rdynamic_attr_state_if
+      attrs.each do |key, val|
+        if val.key?(:validates) && !val[:validates].empty?
+          opts = val[:validates]
+
+          # Check if validation should only be used in specific state
+          if val.key?(:on) && _dynamic_attr_state_if && _dynamic_attr_state_if.class == Proc
+            validates_on = val[:on]
+            # If validates contains if statement, wrap that statement in state check
+            if val[:validates].key?(:if)
+              original_if = val[:validates][:if]
+              opts.merge! if: ->(model) { model.instance_exec(validates_on, &_dynamic_attr_state_if) && model.instance_eval(&original_if) }
+            else
+              opts.merge! if: ->(model) { model.instance_exec(validates_on, &_dynamic_attr_state_if) }
+            end
+          end
+
+          validates key.to_sym, opts.deep_symbolize_keys()
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, DynamicAttributeDeclaration)

data/lib/dynamic_attribute_declaration/version.rb

@@ -0,0 +1,3 @@
+module DynamicAttributeDeclaration
+  VERSION = "0.0.10"
+end

data/spec/lib/dynamic_attribute_declaration_spec.rb

@@ -0,0 +1,266 @@
+require 'spec_helper'
+
+describe "Dynamic Attribute Declaration" do
+
+  let(:cls) { Phone }
+
+  describe "Basic gem tests" do
+
+    it "Accessor _dynamic_attrs should be Hash" do
+      expect(cls._dynamic_attrs.class).to eq Hash
+    end
+
+    %w(define_attrs attrs_for attrs_names_for build_validations_from_dynamic_attrs).each do |attr|
+      it "Should respond to #{attr}" do
+        expect(cls).to respond_to(attr.to_sym)
+      end
+    end
+  end
+
+  describe "Defining attrs" do
+
+    it "Clean Model should have no validators" do
+      expect(cls.validators).to eq []
+    end
+
+    describe "Simple definition of presence validator" do
+      let(:defition_array) { [{name:{validates:{presence: true}}}] }
+      let(:definition) { Hash[*defition_array.flatten] }
+
+      before do
+        cls.define_attrs definition
+      end
+
+      it "Should have at least one validator" do
+        expect(cls.validators).not_to eq []
+        expect(cls.validators.length).to be >= 1
+      end
+
+      it "Should have a specific validator" do
+        obj = definition
+        name = obj.keys.first
+        validators = obj[name][:validates]
+        validator_type = validators.keys.first
+
+        validator = cls.validators.first
+        expect(validator.class).to eq "ActiveRecord::Validations::#{validator_type.capitalize}Validator".constantize
+      end
+
+      it "_dynamic_attrs should have configuration from define_attrs" do
+        expect(cls._dynamic_attrs).to eq definition
+      end
+
+      it "attrs_for with no state should return definition" do
+        expect(cls.attrs_for).to eq definition
+      end
+
+      it "attrs_names_for with no state should return definition" do
+        expect(cls.attrs_names_for).to eq definition.keys
+      end
+    end
+
+    describe "Simple definition of presence validator, with on parameter" do
+      let(:defition_array) { [{name:{validates:{presence: true}, on: :right}}] }
+      let(:definition) { Hash[*defition_array.flatten] }
+      let(:instance) { cls.new }
+
+      before do
+        cls.define_attrs definition
+      end
+
+      it "Should have at least one validator" do
+        expect(cls.validators).not_to eq []
+        expect(cls.validators.length).to be >= 1
+      end
+
+      it "Should have a specific validator" do
+        obj = definition
+        name = obj.keys.first
+        validators = obj[name][:validates]
+        validator_type = validators.keys.first
+
+        validator = cls.validators.first
+        expect(validator.class).to eq "ActiveRecord::Validations::#{validator_type.capitalize}Validator".constantize
+      end
+
+      it "_dynamic_attrs should have configuration from define_attrs" do
+        expect(cls._dynamic_attrs).to eq definition
+      end
+
+      describe "attrs_for" do
+        it "with no state should return definition" do
+          expect(cls.attrs_for).to eq definition
+        end
+        describe "with right state" do
+          it "with symbol should return definition" do
+            expect(cls.attrs_for(:right)).to eq definition
+          end
+          it "with string should return definition" do
+            expect(cls.attrs_for("right")).to eq definition
+          end
+        end
+        describe "with wrong state" do
+          it "with symbol should return empty object" do
+            expect(cls.attrs_for(:wrong)).to eq({})
+          end
+          it "with string should return empty object" do
+            expect(cls.attrs_for("wrong")).to eq({})
+          end
+        end
+      end
+
+      describe "attrs_names_for" do
+        it "with no state should return definition keys" do
+          expect(cls.attrs_names_for).to eq definition.keys
+        end
+        describe "with right state" do
+          it "with symbol should return definition keys" do
+            expect(cls.attrs_names_for(:right)).to eq definition.keys
+          end
+          it "with string should return definition keys" do
+            expect(cls.attrs_names_for("right")).to eq definition.keys
+          end
+        end
+        describe "with wrong state" do
+          it "with symbol should return empty array" do
+            expect(cls.attrs_names_for(:wrong)).to eq []
+          end
+          it "with string should return empty array" do
+            expect(cls.attrs_names_for("wrong")).to eq []
+          end
+        end
+      end
+
+      describe "values_for" do
+        pending "TEST VALUES FOR"
+      end
+    end
+  end
+
+  describe "Defining define_attr_state_if" do
+    before do
+      cls.clear_dynamic_attrs!
+    end
+
+    it "Should have no _dynamic_attr_state_if as standard" do
+      expect(cls._dynamic_attr_state_if).to be_nil
+    end
+
+    it "lala" do
+      proc = Proc.new { true }
+      cls.define_attr_state_if proc
+      expect(cls._dynamic_attr_state_if).to eq proc
+    end
+  end
+
+  describe "Model Instance" do
+    let(:cls) { Phone }
+
+    describe "With no validator" do
+      let(:instance) { cls.new }
+
+      before do
+        cls.clear_validators!
+      end
+
+      it "Should be valid" do
+        instance.valid?
+        expect(instance.valid?).to eq true
+        expect(instance.errors.full_messages).to eq []
+      end
+    end
+
+    describe "With validator" do
+      let(:defition_array) { [{name:{validates:{presence: true}, on: :right}}] }
+      let(:definition) { Hash[*defition_array.flatten] }
+
+      before do
+        cls.clear_validators!
+        cls.clear_dynamic_attrs!
+
+        cls.define_attr_state_if Proc.new { |value|
+          self.validator value
+        }
+        cls.define_attrs definition
+      end
+
+      describe "With rigth validatable state" do
+        let(:instance) { cls.new }
+
+        before do
+          instance.state = :right
+        end
+
+        it "Should not be valid when having no value" do
+          instance.valid?
+          expect(instance.valid?).to eq false
+          expect(instance.errors.full_messages).not_to eq []
+        end
+        it "Should be valid when having a value" do
+          instance.name = 'My Phone'
+          instance.valid?
+          expect(instance.valid?).to eq true
+          expect(instance.errors.full_messages).to eq []
+        end
+      end
+
+      describe "With wrong validatable state" do
+        let(:instance) { cls.new }
+
+        before do
+          instance.state = :wrong
+        end
+
+        it "Should be valid when having no value" do
+          instance.valid?
+          expect(instance.valid?).to eq true
+          expect(instance.errors.full_messages).to eq []
+        end
+        it "Should be valid when having a value" do
+          instance.name = 'My Phone'
+          instance.valid?
+          expect(instance.valid?).to eq true
+          expect(instance.errors.full_messages).to eq []
+        end
+      end
+
+      describe "With no validatable state" do
+        let(:instance) { cls.new }
+
+        it "Should be valid when having no value" do
+          instance.valid?
+          expect(instance.valid?).to eq true
+          expect(instance.errors.full_messages).to eq []
+        end
+        it "Should be valid when having a value" do
+          instance.name = 'My Phone'
+          instance.valid?
+          expect(instance.valid?).to eq true
+          expect(instance.errors.full_messages).to eq []
+        end
+      end
+    end
+  end
+
+  describe "Multiple models" do
+
+    before do
+      [Phone, Car].each do |model|
+        model.clear_validators!
+        model.clear_dynamic_attrs!
+      end
+    end
+
+    it "_dynamic_attrs should be different" do
+      expect(Phone._dynamic_attrs).to eq({})
+      expect(Car._dynamic_attrs).to eq({})
+
+      Phone.define_attrs [{name:{validates:{presence: true}, on: :right}}]
+      Car.define_attrs [{name:{validates:{presence: true}, on: :another}}]
+      expect(Phone._dynamic_attrs).not_to eq({})
+      expect(Car._dynamic_attrs).not_to eq({})
+
+      expect(Phone._dynamic_attrs).not_to eq Car._dynamic_attrs
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+require 'database_cleaner'
+require 'rspec/its'
+
+# Initialize AR connection
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+# Require dynamic_attribute_declaration gem
+require 'dynamic_attribute_declaration'
+# Load and build test models
+require 'support/models'
+
+# Configure RSpec
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+
+load File.dirname(__FILE__) + '/schema.rb'
+
+class Phone < ActiveRecord::Base
+  attr_accessor :state
+
+  def validator value
+    state == value
+  end
+end
+
+class Car < ActiveRecord::Base
+  attr_accessor :state
+
+  def validator value
+    state == value
+  end
+end

data/spec/support/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :phones, force: true do |t|
+    t.string :name
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_attribute_declaration
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- Mikkel Wied Frederiksen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: sqlite3
+  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: database_cleaner
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- mikkel@wied.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dynamic_attribute_declaration.gemspec
+- lib/dynamic_attribute_declaration.rb
+- lib/dynamic_attribute_declaration/version.rb
+- spec/lib/dynamic_attribute_declaration_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.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.3.0
+signing_key: 
+specification_version: 4
+summary: This gem lets you dynamically declare validations, that can function as partly
+  applied validation, based on some kind of model instance state.
+test_files:
+- spec/lib/dynamic_attribute_declaration_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb