active_dynamic 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d92620f81411267c43b5853c4c9ba25318127c3
-  data.tar.gz: e3aa5c3a7543620f6926e76ed7cfcdbe29509bac
+  metadata.gz: 3649641f159230e047d4ed22374903e4d44c5448
+  data.tar.gz: f62be0e967b33900ef4ca9a02065e87309a1e57c
 SHA512:
-  metadata.gz: 25e660b0d0963fd391a4b05da9d737f01d660f3f77314753140ec6440744352614211eb6cbb8240ab6ba658e9e653089efe10c1a2e202de00b1b52fcafaf490b
-  data.tar.gz: e495087ab547802acda4ebfacbc432f6bae19911b42e5b3679c3f3c0a4f7a0d6eac510ac7eaa9f88c065cfd9e733ffdee72624373656cee19dffcc71515c2813
+  metadata.gz: 2b66e1bdbfc527daf2ba731c19a49ebc5019e0eaf02cbc9956a2829c0dda4b78dc186defa64d4e93e6d405ed82b632a0c31d1361fac66e0eef0339825ce70384
+  data.tar.gz: 35bf9ad3bbbb62cd89eba2aec8b5c5afcf50cddb12ba7af69c357e5f2c9459d04c58ee08b460381126d520d9bda3c6a33170abf38555b6d8a31ad1718bbb327d

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBody:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/active_dynamic.svg)](https://badge.fury.io/rb/active_dynamic)
 [![Code Climate](https://codeclimate.com/github/koss-lebedev/active_dynamic/badges/gpa.svg)](https://codeclimate.com/github/koss-lebedev/active_dynamic)
+[![Build Status](https://travis-ci.org/koss-lebedev/active_dynamic.svg?branch=master)](https://travis-ci.org/koss-lebedev/active_dynamic)
 
 ActiveDynamic allows to dynamically add properties to your ActiveRecord models and 
 work with them as regular properties.
@@ -48,9 +49,9 @@ end
 
 class ProfileAttributeProvider
 
-  # Constructor will receive instance of a model to which dynamic attributes are added
+  # Constructor will receive an instance to which dynamic attributes are added
   def initialize(model)
-    @model = model    
+    @model = model
   end
   
   # This method has to return array of dynamic field definitions.
@@ -70,6 +71,69 @@ end
 
 ```
 
+To resolve dynamic attribute definitions for more than one model:
+
+```ruby
+class Profile < ActiveRecord::Base
+  has_dynamic_attributes
+  
+  # ...
+end  
+ 
+class Document < ActiveRecord::Base
+  has_dynamic_attributes
+  
+  # ...
+end  
+ 
+class ProfileAttributeProvider
+ 
+  def initialize(model)
+    @model = model   
+  end
+  
+  def call
+    case @model
+      when Profile
+        [
+          # attribute definitions for Profile model
+        ]
+      when Document
+        [
+          # attribute definitions for Document model
+        ]
+      else
+        []
+    end
+  end
+  
+end
+```
+
+## How ActiveDynamic resolves dynamic attributes
+
+When you work with unsaved models, ActiveDynamic will use `provider_class` to resolve a list 
+of dynamic attributes, and it will store them alongside the model when the model is saved. 
+So next time when you load that model from DB, ActiveDynamic won't look into `provider_class` 
+and it will load only the dynamic attributes that were created when the model was saved for 
+the first time.
+
+If you want dynamic attributes to be resolved from `provider_class` for persisted models as well,
+you can use `resolve_persisted` configuration option:
+
+```ruby
+# lib/initializers/dynamic_attribute.rb
+
+ActiveDynamic.configure do |config|
+  # ... 
+  
+  # you can set it to Bool value to apply the behavior to all models
+  config.resolve_persisted = true
+  
+  # or you can set it to a Proc to configure the behavior on per-class basis
+  config.resolve_persisted = Proc.new { |model| model.is_a?(Profile) ? true  : false }
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -7,4 +7,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/active_dynamic.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_dynamic/version'

data/lib/active_dynamic.rb

@@ -7,4 +7,4 @@ require 'active_dynamic/has_dynamic_attributes'
 require 'active_dynamic/active_record'
 require 'active_dynamic/configuration'
 require 'active_dynamic/null_provider'
-require 'active_dynamic/version'
+require 'active_dynamic/version'

data/lib/active_dynamic/active_record.rb

@@ -8,4 +8,4 @@ module ActiveDynamic
   end
 end
 
-ActiveRecord::Base.extend ActiveDynamic::ActiveRecord
+ActiveRecord::Base.extend ActiveDynamic::ActiveRecord

data/lib/active_dynamic/attribute_definition.rb

@@ -1,14 +1,21 @@
 module ActiveDynamic
   class AttributeDefinition
 
-    attr_reader :display_name, :name, :datatype, :value
+    attr_reader :display_name, :datatype, :value, :name
 
-    def initialize(display_name, options = {})
+    def initialize(display_name, params = {})
+      options = params.dup
+      @name = (options.delete(:system_name) || display_name).parameterize.underscore
       @display_name = display_name
-      @name = options[:system_name] || display_name.gsub(/[^a-zA-Z\s]/, ''.freeze).gsub(/\s+/, '_'.freeze)
-      @datatype = options[:datatype]
-      @value = options[:default_value]
-      @required = options[:required]
+      @datatype = options.delete(:datatype)
+      @value = options.delete(:default_value)
+      @required = options.delete(:required)
+
+      # custom attributes from Provider
+      options.each do |key, value|
+        self.instance_variable_set("@#{key}", value)
+        self.class.send(:attr_reader, key)
+      end
     end
 
     def required?
@@ -16,4 +23,4 @@ module ActiveDynamic
     end
 
   end
-end
+end

data/lib/active_dynamic/configuration.rb

@@ -4,11 +4,7 @@ module ActiveDynamic
 
   def self.configure
     @@configuration = Configuration.new
-
-    if block_given?
-      yield configuration
-    end
-
+    yield configuration if block_given?
     configuration
   end
 
@@ -22,9 +18,11 @@ module ActiveDynamic
       @provider_class || NullProvider
     end
 
-    def provider_class=(klass)
-      @provider_class = klass
+    def resolve_persisted
+      @resolve_persisted || false
     end
 
+    attr_writer :provider_class, :resolve_persisted
+
   end
 end

data/lib/active_dynamic/has_dynamic_attributes.rb

@@ -3,15 +3,19 @@ module ActiveDynamic
     extend ActiveSupport::Concern
 
     included do
-      has_many :active_dynamic_attributes, class_name: ActiveDynamic::Attribute, autosave: true, as: :customizable
+      has_many :active_dynamic_attributes,
+               class_name: ActiveDynamic::Attribute,
+               autosave: true,
+               dependent: :destroy,
+               as: :customizable
       before_save :save_dynamic_attributes
     end
 
     def dynamic_attributes
-      if persisted?
-        active_dynamic_attributes.order(:created_at)
+      if persisted? && any_dynamic_attributes?
+        should_resolve_persisted? ? resolve_combined : resolve_from_db
       else
-        ActiveDynamic.configuration.provider_class.new(self.class).call
+        resolve_from_provider
       end
     end
 
@@ -23,10 +27,8 @@ module ActiveDynamic
       if super
         true
       else
-        unless dynamic_attributes_loaded?
-          load_dynamic_attributes
-        end
-        dynamic_attributes.find { |attr| attr.name == method_name.to_s.gsub(/=/, '') }.present?
+        load_dynamic_attributes unless dynamic_attributes_loaded?
+        dynamic_attributes.find { |attr| attr.name == method_name.to_s.delete('=') }.present?
       end
     end
 
@@ -39,7 +41,39 @@ module ActiveDynamic
       end
     end
 
-  private
+    private
+
+    def should_resolve_persisted?
+      value = ActiveDynamic.configuration.resolve_persisted
+      case value
+      when TrueClass, FalseClass
+        value
+      when Proc
+        value.call(self)
+      else
+        raise "Invalid configuration for resolve_persisted. Value should be Bool or Proc, got #{value.class}"
+      end
+    end
+
+    def any_dynamic_attributes?
+      active_dynamic_attributes.any?
+    end
+
+    def resolve_combined
+      attributes = resolve_from_db
+      resolve_from_provider.each do |attribute|
+        attributes << ActiveDynamic::Attribute.new(attribute.as_json) unless attributes.find { |attr| attr.name == attribute.name }
+      end
+      attributes
+    end
+
+    def resolve_from_db
+      active_dynamic_attributes
+    end
+
+    def resolve_from_provider
+      ActiveDynamic.configuration.provider_class.new(self).call
+    end
 
     def generate_accessors(fields)
       fields.each do |field|
@@ -58,7 +92,7 @@ module ActiveDynamic
     end
 
     def add_presence_validator(attribute)
-      self.singleton_class.instance_eval do
+      singleton_class.instance_eval do
         validates_presence_of(attribute)
       end
     end
@@ -78,18 +112,15 @@ module ActiveDynamic
 
     def save_dynamic_attributes
       dynamic_attributes.each do |field|
-        props = { name: field.name, display_name: field.display_name,
-                  datatype: field.datatype, value: field.value }
-        attr = self.active_dynamic_attributes.find_or_initialize_by(props)
-        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
+        next unless _custom_fields[field.name]
+        attr = active_dynamic_attributes.find_or_initialize_by(field.as_json)
+        if 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

@@ -1,8 +1,15 @@
 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
+  # Specify class in your 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
+  
+  # When new dynamic attributes are defined after object was saved, 
+  # should object get this attributes automatically when editing? 
+  # New attribute definitions are created automatically. 
+  # Set true or false (default)
+  # config.resolve_persisted = true
 
-end
+end

data/lib/active_dynamic/migration.rb

@@ -5,10 +5,10 @@ class CreateActiveDynamicAttributesTable < ActiveRecord::Migration[4.2]
       t.integer :customizable_id, null: false
       t.string :customizable_type, limit: 50
 
-      t.string :display_name, null: false
       t.string :name
-      t.text :value
+      t.string :display_name, null: false
       t.integer :datatype
+      t.text :value
       t.boolean :required, null: false, default: false
 
       t.timestamps

data/lib/active_dynamic/null_provider.rb

@@ -1,7 +1,7 @@
 module ActiveDynamic
   class NullProvider
 
-    def initialize(model_class)
+    def initialize(model)
     end
 
     def call

data/lib/active_dynamic/version.rb

@@ -1,3 +1,3 @@
 module ActiveDynamic
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'.freeze
 end

data/lib/generators/active_dynamic_generator.rb

@@ -3,12 +3,13 @@ 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
+  # 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"
+  class_option :'skip-initializer', type: :boolean, desc: "Don't generate an initializer"
 
   source_root File.expand_path('../../active_dynamic', __FILE__)
 
@@ -22,4 +23,4 @@ class ActiveDynamicGenerator < ActiveRecord::Generators::Base
     copy_file 'initializer.rb', 'config/initializers/active_dynamic.rb'
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_dynamic
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Constantine Lebedev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt