active_dynamic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 165e1a192514f78811d5e4dc661da1dfd8971fa7
+  data.tar.gz: d5ed75bd800f761fe66247c9a076e7edc98b466a
+SHA512:
+  metadata.gz: bd209021677c3b3965e2797bc03431ef5363ce845bd1ed52dad51eaf4fd10051621897c8be128196ee0676cce2c639d57810e0f5a24c7ca785898fdab231a925
+  data.tar.gz: cb08aec84ade3e2277a3784231978c9708419c54b386786104642cb985dd9d0c0c551a7914dce41e06c794edca11af5903ac1707334eb5346ce72218aca4307e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Constantine Lebedev
+
+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,75 @@
+# ActiveDynamic
+
+ActiveDynamic allows to dynamically add properties to your ActiveRecord models and 
+work with them as regular properties.
+To see this in practice, check out the demo application available at [https://github.com/koss-lebedev/active_dynamic_demo](https://github.com/koss-lebedev/active_dynamic_demo)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_dynamic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_dynamic
+
+## Usage
+
+To make this gem work, first you need to include `HasDynamicAttributes` concern to the model that needs to have dynamic 
+attributses. For example, if you have `Profile` model:
+ 
+```ruby
+class Profile < ActiveRecord::Base
+  include DynamicAttributes::HasDynamicAttributes
+  
+  # ...
+end  
+```
+
+After that you need to set a class that will resolve definitions of the dynamic attributes to be created on `Profile` model:
+
+```ruby
+# lib/initializers/dynamic_attribute.rb
+
+ActiveDynamic.configure do |config|
+  config.provider_class = ProfileAttributeProvider
+end
+
+class ProfileAttributeProvider
+
+  # Constructor will receive instance of a model to which dynamic attributes are added
+  def initialize(model)
+    @model = model    
+  end
+  
+  # This method has to return array of dynamic field definitions.
+  # You can get it from the configuration file, DB, etc., depending on your app logic
+  def call
+    [
+      # attribute definition has to specify attribute name, datatype, and optionally default value
+      ActiveDynamic::AttributeDefinition.new('age', ActiveDynamic::DataType::Integer, 18),
+      ActiveDynamic::AttributeDefinition.new('biography', ActiveDynamic::DataType::Text)
+    ]
+  end
+  
+end
+
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/koss-lebedev/active_dynamic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/active_dynamic.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_dynamic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_dynamic'
+  spec.version       = ActiveDynamic::VERSION
+  spec.authors       = ['Constantine Lebedev']
+  spec.email         = ['koss.lebedev@gmail.com']
+
+  spec.summary       = 'Gem that allows to attach dynamic attributes to ActiveRecord model'
+  spec.description   = 'Gem that allows to attach dynamic attributes to ActiveRecord model'
+  spec.homepage      = 'https://github.com/koss-lebedev/active_dynamic'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.0', '< 5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'active_dynamic'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_dynamic/attribute.rb

@@ -0,0 +1,9 @@
+module ActiveDynamic
+  class Attribute < ActiveRecord::Base
+    belongs_to :customizable, polymorphic: true
+
+    self.table_name = 'active_dynamic_attributes'
+    validates :name, presence: true
+    validates :datatype, presence: true, inclusion: DataType::All
+  end
+end

data/lib/active_dynamic/attribute_definition.rb

@@ -0,0 +1,4 @@
+module ActiveDynamic
+  class AttributeDefinition < Struct.new(:name, :datatype, :value)
+  end
+end

data/lib/active_dynamic/configuration.rb

@@ -0,0 +1,30 @@
+module ActiveDynamic
+
+  @@configuration = nil
+
+  def self.configure
+    @@configuration = Configuration.new
+
+    if block_given?
+      yield configuration
+    end
+
+    configuration
+  end
+
+  def self.configuration
+    @@configuration || configure
+  end
+
+  class Configuration
+
+    def provider_class
+      @provider_class || NullProvider
+    end
+
+    def provider_class=(klass)
+      @provider_class = klass
+    end
+
+  end
+end

data/lib/active_dynamic/data_type.rb

@@ -0,0 +1,12 @@
+module ActiveDynamic
+  module DataType
+    String = 0
+    Text = 1
+    Integer = 2
+    Decimal = 3
+    Date = 4
+    DateTime = 5
+
+    All = [String, Text, Integer, Decimal]
+  end
+end

data/lib/active_dynamic/has_dynamic_attributes.rb

@@ -0,0 +1,71 @@
+module ActiveDynamic
+  module HasDynamicAttributes
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :active_dynamic_attributes, class_name: ActiveDynamic::Attribute, autosave: true, as: :customizable
+
+      after_initialize :load_dynamic_attributes
+      before_save :save_dynamic_attributes
+    end
+
+    # def initialize(*args)
+    #   super
+    #   load_dynamic_attributes
+    # end
+
+    def dynamic_attributes
+      if persisted?
+        active_dynamic_attributes.order(:created_at)
+      else
+        ActiveDynamic.configuration.provider_class.new(self).call
+      end
+    end
+
+    def dynamic_attr_names
+      dynamic_attributes.map(&:name)
+    end
+
+  private
+
+    def generate_accessors(fields)
+      fields.map(&:name).each do |field|
+
+        define_singleton_method(field) do
+          _custom_fields[field]
+        end
+
+        define_singleton_method("#{field}=") do |value|
+          _custom_fields[field] = value.strip
+        end
+
+      end
+    end
+
+    def _custom_fields
+      @_custom_fields ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    def load_dynamic_attributes
+      dynamic_attributes.each do |ticket_field|
+        _custom_fields[ticket_field.name] = ticket_field.value
+      end
+
+      generate_accessors dynamic_attributes
+    end
+
+    def save_dynamic_attributes
+      dynamic_attributes.each do |field|
+        attr = self.active_dynamic_attributes.find_or_initialize_by(name: field.name, datatype: field.datatype)
+        if _custom_fields[field.name]
+          if self.persisted?
+            attr.update(value: _custom_fields[field.name])
+          else
+            attr.assign_attributes(value: _custom_fields[field.name])
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/active_dynamic/initializer.rb

@@ -0,0 +1,8 @@
+ActiveDynamic.configure do |config|
+
+  # Specify class inyour application responsible for resolving dynamic properties for your model.
+  # this class should accept `model` as the only constructor parameter, and have a `call` method
+  # that returns an array of AttributeDefinition
+  config.provider_class = ActiveDynamic::NullProvider
+
+end

data/lib/active_dynamic/migration.rb

@@ -0,0 +1,19 @@
+class CreateActiveDynamicAttributesTable < ActiveRecord::Migration[4.2]
+
+  def change
+    create_table :active_dynamic_attributes do |t|
+      t.integer :customizable_id, null: false
+      t.string :customizable_type, limit: 50
+
+      t.string :name, null: false
+      t.text :value
+      t.integer :datatype, null: false
+
+      t.timestamps
+    end
+
+    add_index :active_dynamic_attributes, :customizable_id
+    add_index :active_dynamic_attributes, :customizable_type
+  end
+
+end

data/lib/active_dynamic/null_provider.rb

@@ -0,0 +1,12 @@
+module ActiveDynamic
+  class NullProvider
+
+    def initialize(model_class)
+    end
+
+    def call
+      []
+    end
+
+  end
+end

data/lib/active_dynamic/version.rb

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

data/lib/active_dynamic.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+require 'active_dynamic/data_type'
+require 'active_dynamic/attribute_definition'
+require 'active_dynamic/attribute'
+require 'active_dynamic/has_dynamic_attributes'
+require 'active_dynamic/configuration'
+require 'active_dynamic/null_provider'
+require 'active_dynamic/version'

data/lib/generators/active_dynamic_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class ActiveDynamicGenerator < ActiveRecord::Generators::Base
+
+  # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase which requires a NAME parameter for the
+  # new table name. Our generator always uses 'active_dynamic_attributes', so default value is irrelevant
+  argument :name, type: :string, default: 'dummy'
+
+  class_option :'skip-migration', type: :boolean, desc: "Don't generate a migration for the dynamic attributes table"
+  class_option :'skip-initializer', :type => :boolean, :desc => "Don't generate an initializer"
+
+  source_root File.expand_path('../../active_dynamic', __FILE__)
+
+  def copy_files
+    return if options['skip-migration']
+    migration_template 'migration.rb', 'db/migrate/create_active_dynamic_attributes_table.rb'
+  end
+
+  def create_initializer
+    return if options['skip-initializer']
+    copy_file 'initializer.rb', 'config/initializers/active_dynamic.rb'
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: active_dynamic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Constantine Lebedev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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'
+description: Gem that allows to attach dynamic attributes to ActiveRecord model
+email:
+- koss.lebedev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_dynamic.gemspec
+- bin/console
+- bin/setup
+- lib/active_dynamic.rb
+- lib/active_dynamic/attribute.rb
+- lib/active_dynamic/attribute_definition.rb
+- lib/active_dynamic/configuration.rb
+- lib/active_dynamic/data_type.rb
+- lib/active_dynamic/has_dynamic_attributes.rb
+- lib/active_dynamic/initializer.rb
+- lib/active_dynamic/migration.rb
+- lib/active_dynamic/null_provider.rb
+- lib/active_dynamic/version.rb
+- lib/generators/active_dynamic_generator.rb
+homepage: https://github.com/koss-lebedev/active_dynamic
+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.8
+signing_key: 
+specification_version: 4
+summary: Gem that allows to attach dynamic attributes to ActiveRecord model
+test_files: []