dynabute 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a3e4c339e4f0b130aa62ba41b5f1c599907a3dc4
-  data.tar.gz: 9aba54882546c3170d9139837e94c0fdff73bdcd
+SHA256:
+  metadata.gz: e2f0aa518cab55eb4e4f2530660132ab9719b5ecb751f556d338662fb0668157
+  data.tar.gz: 3890334d7ff87796ec5c8e9f6bda8e219377a082de93854ea14930384eace26b
 SHA512:
-  metadata.gz: a1b09eedf82cf2da833070db114decbf7f5d31080d2f4a960b15be3988f958b9301d553a9e900a1dab9ba98224170dac7259a927b97e3d38908ecef9c6b6ff53
-  data.tar.gz: 34fc3b7472b1cec43a84c75663dea4b332955df8410ed98caf5c4524affbcb90f27b535ffc7f77e7f7998303d1bb032ece3b5adf1df095d2c84415f8afa3cefb
+  metadata.gz: 95015958c27c3de3af3d286440ec71d463bd0e517099eb1be4128f347c75e2bc22dff339e3e09ffe5062f29271a17b041a9cb5ba29f70433842232c58642eb3d
+  data.tar.gz: cb46b6dca7dc04ce5362b85313d1d8665cc4273fe6ea78b0622332ffe29ebe393ad40d2df34af179d53992218082233ecf9ff416906b066898c712e1a6b7d0af

data/README.md

@@ -1,5 +1,7 @@
 # Dynabute
-Dynamically add attributes on Relational Database backed ActiveRecord, without hash serialization and bullshits
+Dynamically add attributes on Relational Database backed ActiveRecord, without hash serialization and bullshits.
+
+Try messing with a [working demo](https://dynabute-demo.herokuapp.com).
 
 ## Usage
 
@@ -12,17 +14,17 @@ end
 
 then add some field definitions
 ```ruby
-User.dynabutes << Dynabute::Field.new( name: 'age', value_type: 'integer' )
-User.dynabutes << Dynabute::Field.new( name: 'skinny', value_type: 'boolean' )
-User.dynabutes << Dynabute::Field.new( name: 'personalities', value_type: 'string', has_many: true )
+User.dynabutes.create( name: 'age', value_type: 'integer' )
+User.dynabutes.create( name: 'skinny', value_type: 'boolean' )
+User.dynabutes.create( name: 'personalities', value_type: 'string', has_many: true )
 ```
 
 now set value
 ```ruby
 user = User.create
 
-user.build_dynabute_value( name: 'age', value: 35 ).save
-# => <Dynabute::Values::IntegerValue:0x007faba5279540 id: 1, field_id: 1, dynabutable_id: 1, dynabutable_type: "User", value: 35>
+user.set_dynabute_value( name: 'age', value: 35 ).save
+# => true
 ```
 
 check the value
@@ -50,13 +52,13 @@ user.update(
 )
 ```
 
-`select` value_type is also available 
+`select` value_type is also available
 ```ruby
-User.dynabutes << Dynabute::Field.new( name: 'gender', value_type: 'select', options_attributes: [ { label: 'male' }, { label: 'female' } ] )
-User.dynabutes << Dynabute::Field.new( name: 'hobbies', has_many: true, value_type: 'select',  options_attributes: [ { label: 'running' }, { label: 'swimming' }, { label: 'hiking' } ] )
+User.dynabutes.create( name: 'gender', value_type: 'select', options_attributes: [ { label: 'male' }, { label: 'female' } ] )
+User.dynabutes.create( name: 'hobbies', has_many: true, value_type: 'select',  options_attributes: [ { label: 'running' }, { label: 'swimming' }, { label: 'hiking' } ] )
 ```
 
-list the available options for a field 
+list the available options for a field
 ```ruby
 User.dynabutes.find_by(name: gender).options
 # => [#<Dynabute::Option:0x007ff53e2e1f90 id: 1, field_id: 4, label: "male">,
@@ -74,7 +76,7 @@ user.update(dynabute_values_attributes: [
  { name: 'hobbies', value: hobbies[1].id }
 ])
 ```
- 
+
 check out the selected options
 ```ruby
 user.dynabute_value(name: 'gender').option
@@ -84,7 +86,16 @@ user.dynabute_value(name: 'hobbies').map(&:option)
 # => [#<Dynabute::Option:0x007fb26c4467d8 id: 5, field_id: 5, label: "running">,
 #     #<Dynabute::Option:0x007fb26c446238 id: 6, field_id: 5, label: "swimming">]
 ```
- 
+
+remove value
+
+```
+user.remove_dynabute_value(name: 'age')
+# => #<Dynabute::Values::StringValue:0x0000 ... dynabutable_type: "User", value: 35>
+```
+
+
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -98,9 +109,22 @@ $ bundle install
 $ rails generate dynabute:install
 $ rake db:migrate
 ```
+## Contributors
+
+[<img src="https://github.com/CrAsH1101.png" width="60px;"/><br /><sub><a href="https://github.com/CrAsH1101">CrAsH1101</a></sub>](https://github.com/CrAsH1101)
 
 ## Contributing
-yea?
+
+#### Rspec: set test environment
+```bash
+$ bundle install
+$ cd spec/dummy/
+$ RAILS_ENV=test bundle exec rake db:create
+$ RAILS_ENV=test bundle exec rake db:migrate
+$ cd ../../
+$ bundle exec rspec
+```
+
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/dynabute/dynabutable.rb

@@ -4,6 +4,7 @@ require 'dynabute/nested_attributes'
 
 module Dynabute
   module Dynabutable
+    class ValueNotFound < StandardError; end
     extend ActiveSupport::Concern
 
     included do
@@ -11,7 +12,7 @@ module Dynabute
       include NestedAttributes::API
 
       (Dynabute::Field::TYPES).each do |t|
-        has_many Util.value_relation_name(t), class_name: Util.value_class_name(t), as: :dynabutable
+        has_many Util.value_relation_name(t), class_name: Util.value_class_name(t), as: :dynabutable, inverse_of: 'dynabutable', dependent: :delete_all
         accepts_nested_attributes_for Util.value_relation_name(t), reject_if: proc{ |param| param[:value].blank? }, allow_destroy: true
       end
 
@@ -36,18 +37,73 @@ module Dynabute
       end
 
       def dynabute_value(name: nil, field_id: nil, field: nil)
-        field = find_field(name, field_id, field)
-
-        if field.has_many
-          send(Util.value_relation_name(field.value_type)).select{|v| v.field_id == field.id }
+        field_obj = find_field(name, field_id, field)
+        field_values = send(Util.value_relation_name(field_obj.value_type))
+        field_value = if field_obj.has_many
+          field_values.select{ |v| v.field_id == field_obj.id }
         else
-          send(Util.value_relation_name(field.value_type)).detect{|v| v.field_id == field.id }
+          field_values.detect{ |v| v.field_id == field_obj.id }
         end
+        field_value
       end
 
       def build_dynabute_value(name: nil, field_id: nil, field: nil, **rest)
-        field = find_field(name, field_id, field)
-        send(Util.value_relation_name(field.value_type)).build(field_id: field.id, **rest)
+        field_obj = find_field(name, field_id, field)
+        send(Util.value_relation_name(field_obj.value_type)).build(field_id: field_obj.id, **rest)
+      end
+
+      # Returns value attribute for specified field.
+      # If field can have multiple values for single target model object,
+      # an array of values is returned, unless specific value_id is provided.
+      def get_dynabute_value(name: nil, field_id: nil, field: nil, value_id: nil)
+        field_obj = find_field(name, field_id, field)
+        value_obj = dynabute_value(field: field_obj)
+        return unless value_obj
+        if field_obj.has_many && value_id
+          value_obj = value_obj.detect{|v| v.id == value_id}
+        end
+        value_obj.is_a?(Array) ? value_obj.map(&:value) : value_obj&.value
+      end
+
+      # Sets the value in the target model object nested attribute structure.
+      # If field can have multiple values for single target model object,
+      # a new value will be added, unless specific value_id is provided.
+      #
+      # This method does not store changes in the database. "save" method should
+      # be called on target model to store all changes, or individually on every
+      # value record returned by this method.
+      def set_dynabute_value(name: nil, field_id: nil, field: nil, value: nil, value_id: nil)
+        field_obj = find_field(name, field_id, field)
+        value_obj = dynabute_value(field: field_obj)
+        if field_obj.has_many
+          if value_id
+            value_obj = value_obj.detect{|v| v.id == value_id} if value_obj
+            fail ValueNotFound unless value_obj
+          else
+            value_obj = build_dynabute_value(field: field_obj)
+          end
+        else
+          value_obj ||= build_dynabute_value(field: field_obj)
+        end
+        value_obj.value = value
+        value_obj
+      end
+
+      # Removes value from database and keeps dynabute relations up-to-date.
+      # If field can have multiple values for single target model object,
+      # all values will be removed, unless specific value_id is provided.
+      #
+      # This method stores changes in the database
+      def remove_dynabute_value(name: nil, field_id: nil, field: nil, value_id: nil)
+        field_obj = find_field(name, field_id, field)
+        value_obj = dynabute_value(field: field_obj)
+        if value_obj && field_obj.has_many && value_id
+          value_obj = value_obj.detect{|v| v.id == value_id}
+        end
+        if value_obj
+          result_obj = send(Util.value_relation_name(field_obj.value_type)).destroy(value_obj)
+          value_obj.is_a?(Array) ? result_obj : result_obj.first
+        end
       end
 
       def method_missing(*args)
@@ -63,11 +119,34 @@ module Dynabute
       end
 
       private
+
       def find_field(name, id, field)
-        name_or_id = {name: name, id: id}.compact
-        return nil if name_or_id.blank? && field.blank?
-        field_obj = field || Dynabute::Field.find_by(name_or_id.merge(target_model: self.class.to_s))
-        fail Dynabute::FieldNotFound.new(name_or_id, field) if field_obj.nil?
+        # Validate field argument
+        if field
+          unless field.is_a?(Dynabute::Field)
+            fail ArgumentError, 'Argument field must be Dynabute::Field'
+          end
+          return field
+        end
+        name_or_id = {}
+        # Validate name argument
+        if name
+          unless name.is_a?(String) || name.is_a?(Symbol)
+            fail ArgumentError, 'Argument name must be String or Symbol'
+          end
+          name_or_id[:name] = name.to_s
+        end
+        # Validate id argument
+        if id
+          unless id.is_a?(Integer)
+            fail ArgumentError, 'Argument id must be Integer'
+          end
+          name_or_id[:id] = id
+        end
+        name_or_id.reject!{ |k, v| v.blank? }
+        fail ArgumentError, 'Invalid arguments' if name_or_id.blank?
+        field_obj = Dynabute::Field.find_by(name_or_id.merge(target_model: self.class.to_s))
+        fail Dynabute::FieldNotFound.new(name_or_id) if field_obj.nil?
         field_obj
       end
 

data/lib/dynabute/field.rb

@@ -9,7 +9,7 @@ module Dynabute
     validates :value_type, inclusion: {in: TYPES}
     validates :name, presence: true, uniqueness: { scope: :target_model }
     validates_presence_of :target_model
-    has_many :options, class_name: 'Dynabute::Option', dependent: :destroy
+    has_many :options, class_name: 'Dynabute::Option', dependent: :destroy, inverse_of: 'field'
     accepts_nested_attributes_for :options, allow_destroy: true
 
     scope :for, ->(klass){ where(target_model: klass) }
@@ -22,15 +22,6 @@ module Dynabute
       TYPES
     end
 
-    def self.<<(records)
-      if records.respond_to? :each
-        records.each {|r| r.update!(target_model: get_parent_class_name) }
-      else
-        records.update!(target_model: get_parent_class_name)
-      end
-      all
-    end
-
     private
     def self.get_parent_class_name
       all.where_clause.binds.detect{|w| w.name == 'target_model'}.try(:value)

data/lib/dynabute/option.rb

@@ -4,7 +4,7 @@ module Dynabute
   class Option < ActiveRecord::Base
     def self.table_name_prefix; Util.table_name_prefix; end
     belongs_to :field, class_name: 'Dynabute::Field'
-    has_many :values, class_name: Util.value_class_name(:select), foreign_key: 'value'
+    has_many :values, class_name: Util.value_class_name(:select), foreign_key: 'value', inverse_of: 'option'
     validates :label, presence: true, uniqueness: { scope: ['field_id'] }
     validate Util.nested_attributable_presence_validator(:field_id, :field)
   end

data/lib/dynabute/util.rb

@@ -5,7 +5,7 @@ module Dynabute
         return -> {
           attr = id_attr.to_sym
           if (persisted? && self[attr].nil?) || (new_record? && send(id_relation_accessor).nil?)
-            errors[attr] << I18n.t('errors.messages.blank')
+            errors.add(attr, I18n.t('errors.messages.blank'))
             return fail(:abort) if(halt)
           end
         }

data/lib/dynabute/values/base.rb

@@ -21,7 +21,7 @@ module Dynabute::Values
       def reject_duplication_for_has_one
         return if field.has_many
         return unless self.class.exists?(field_id: field_id, dynabutable_id: dynabutable_id, dynabutable_type: dynabutable_type)
-        self.errors[:base] << 'Multiple records for has_one relationship detected'
+        self.errors.add(:base, 'Multiple records for has_one relationship detected')
         throw :abort
       end
     end

data/lib/dynabute/values/select_value.rb

@@ -7,8 +7,9 @@ module Dynabute
 
       def ensure_option_is_in_same_field
         if option && (option.field_id != field_id)
-          errors[:value] << I18n.t('errors.messages.dynabutes.wrong_field_option',
-                      default: 'is pointing to the option for other dynabute field')
+          errors.add(:value, I18n.t('errors.messages.dynabutes.wrong_field_option',
+            default: 'is pointing to the option for other dynabute field')
+          )
         end
       end
 

data/lib/dynabute/version.rb

@@ -1,3 +1,3 @@
 module Dynabute
-  VERSION = '0.0.13'
+  VERSION = '0.0.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynabute
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Liooo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -28,16 +28,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 description: Dynamically add attributes on ActiveRecord.
 email:
 - ryoyamada3@gmail.com
@@ -141,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: DYNAmic attriBUTEs for ActiveRecord