ar_doc_store 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3700fe9780b88ba20e28eb918e3b49c307750cc
-  data.tar.gz: 0ccdb51dd3e3b5b2c27176282b6f4d0fab67953d
+  metadata.gz: 389dfcb42c57c087c024326589ff09ca183bd224
+  data.tar.gz: ad6f5ac50966c3e2d8979cda69383c28dcaa0908
 SHA512:
-  metadata.gz: e1794e597e28722089e23f160a3caf8f3376427ce57dfd9a5e942ccb24b3820cf37d5c886cc87cfc867451a70d29ed2ee8dbdab43f7380025e3f0284d12c271a
-  data.tar.gz: 8f70729d52793af0a9dc970957ab986970d617792518f80b872c22b5026ead45afc7d641602e63fc6917d77d245f9f93e78c04446a4ac5f9bd72698813aa0fb7
+  metadata.gz: 4416430c4d7d03f97294e0b9fb31b3d03af2bb220d097975ff7ecd4104c27dfe8909125039c09c278dbefc633ebf5a303e95cf6f84e2a95fda10e1907a5d5dcd
+  data.tar.gz: bc49e9c3ed777a4f7fe140f6811ede9ba42123968545c602d121c4a86ad05e307791b21a2bc537eeee25958756d806592bc39d33bd855929cec62d494a4fab44

data/README.md

@@ -1,6 +1,6 @@
 # ArDocStore
 
-ArDocStore (pronounced R-Dock-Store) is a gem helps you implement a document store in ActiveRecord models that have access to the PostgreSQL JSON data type. You add a json column to your table called "data", include the ArDocStore::Model module, and then add schema-less attributes that get stored in the data column. With Ransack, these attributes are searchable as if they were real columns. 
+ArDocStore (pronounced R-Dock-Store) is a gem helps you implement a document store in ActiveRecord models that have access to the PostgreSQL JSON data type. You add a json column to your table called "data", include the ArDocStore::Model module, and then add schema-less attributes that get stored in the data column. With Ransack, these attributes are searchable as if they were real columns.
 
 There is also support for embedding models within models. These embedded models can be accessed from Rails form builders using fields_for.
 
@@ -8,7 +8,7 @@ The use case is primarily when you have a rapidly evolving schema with scores of
 
 Learn more about the JSON column in Postgres and using it as a document store:
 * The Rails Guide on Postgres: http://edgeguides.rubyonrails.org/active_record_postgresql.html
-* Document Store Gymnastics: http://rob.conery.io/2015/03/01/document-storage-gymnastics-in-postgres/ 
+* Document Store Gymnastics: http://rob.conery.io/2015/03/01/document-storage-gymnastics-in-postgres/
 * Query JSON with Rails 4.2 and Postgres 9.4: http://robertbeene.com/rails-4-2-and-postgresql-9-4/
 * PG as NoSQL: http://thebuild.com%5Cpresentations%5Cpg-as-nosql-pgday-fosdem-2013.pdf
 * Why JSON in PostgreSQL is Awesome: https://functionwhatwhat.com/json-in-postgresql/
@@ -49,21 +49,30 @@ class Building < ActiveRecord::Base
 end
 ```
 
+You don't have to use "data" as the column name. Use something else like do:
+```ruby
+class Building < ActiveRecord::Base
+  include ArDocStore::Model
+  self.json_column = :json_data
+end
+```
+
+
 ### Attributes
 
 Now there are several ways to play but all boil down to one method on the model:
 ```ruby
 class Building < ActiveRecord::Base
   include ArDocStore::Model
-	
+
   attribute :name, :string
   attribute :width, :float
   attribute :height, as: :float # the :as is optional but if you like the consistency with SimpleForm
   attribute :storeys, :integer
   attribute :finished, :boolean
-  attribute :construction_type, :enumeration, 
-            values: %w{wood plaster mud brick}, 
-            multiple: true, 
+  attribute :construction_type, :enumeration,
+            values: %w{wood plaster mud brick},
+            multiple: true,
             strict: true
 end
 ```
@@ -81,10 +90,10 @@ You noticed the enumeration type on the construction_type takes an array. That's
 
 ```ruby
 class Building ...
-  attribute :construction_type, 
-            :enumeration, 
-            values: %w{wood plaster mud brick}, 
-            multiple: true, 
+  attribute :construction_type,
+            :enumeration,
+            values: %w{wood plaster mud brick},
+            multiple: true,
             strict: true
 end
 building = Building.new
@@ -101,17 +110,17 @@ Let's say that a building has a door. The building is not the only thing in our
 ```ruby
 class Door
   include ArDocStore::EmbeddableModel
-	
-  enumerates :door_type, 
-             multiple: true, 
+
+  enumerates :door_type,
+             multiple: true,
              values: %w{single double french sliding push pull}
   attribute :open_handle,  
-            as: :enumeration, 
-            multiple: true, 
+            as: :enumeration,
+            multiple: true,
             values: %w{push pull plate knob handle}
-  attribute :close_handle, 
-            as: :enumeration, 
-            multiple: true, 
+  attribute :close_handle,
+            as: :enumeration,
+            multiple: true,
             values: %w{push pull plate knob handle}
   attribute :clear_distance, as: :integer
   attribute :opening_force, as: :integer

data/lib/ar_doc_store/attribute_types/array_attribute.rb

@@ -1,20 +1,20 @@
 module ArDocStore
   module AttributeTypes
-    
+
     class ArrayAttribute < BaseAttribute
 
       def build
         key = attribute.to_sym
         default_value = default
         model.class_eval do
-          store_accessor :data, key
+          store_accessor json_column, key
           define_method key, -> {
-            value = read_store_attribute(:data, key)
+            value = read_store_attribute(json_column, key)
             value or default_value
           }
           define_method "#{key}=".to_sym, -> (value) {
             value = nil if value == ['']
-            write_store_attribute(:data, key, value)
+            write_store_attribute(json_column, key, value)
           }
           add_ransacker(key, 'text')
         end
@@ -28,4 +28,3 @@ module ArDocStore
 
   end
 end
-

data/lib/ar_doc_store/attribute_types/base_attribute.rb

@@ -26,7 +26,7 @@ module ArDocStore
         model.class_eval do
           add_ransacker(attribute, predicate)
           define_method attribute.to_sym, -> {
-            value = read_store_attribute(:data, attribute)
+            value = read_store_attribute(json_column, attribute)
             if value
               value.public_send(typecast_method)
             elsif default_value
@@ -36,9 +36,9 @@ module ArDocStore
           }
           define_method "#{attribute}=".to_sym, -> (value) {
             if value == '' || value.nil?
-              write_store_attribute :data, attribute, nil
+              write_store_attribute json_column, attribute, nil
             else
-              write_store_attribute(:data, attribute, value.public_send(typecast_method))
+              write_store_attribute(json_column, attribute, value.public_send(typecast_method))
             end
           }
         end

data/lib/ar_doc_store/attribute_types/boolean_attribute.rb

@@ -5,11 +5,11 @@ module ArDocStore
       def build
         key = attribute.to_sym
         model.class_eval do
-          store_accessor :data, key
+          store_accessor json_column, key
           define_method "#{key}?".to_sym, -> { public_send(key) == true }
           define_method "#{key}=".to_sym, -> (value) {
             res = ArDocStore.convert_boolean(value)
-            write_store_attribute(:data, key, res)
+            write_store_attribute(json_column, key, res)
           }
           add_ransacker(key, 'bool')
         end

data/lib/ar_doc_store/attribute_types/embeds_many_attribute.rb

@@ -1,9 +1,9 @@
 module ArDocStore
-  
+
   class EmbeddedCollection < Array
     attr_accessor :parent
   end
-  
+
   module AttributeTypes
 
     class EmbedsManyAttribute < BaseAttribute
@@ -11,7 +11,7 @@ module ArDocStore
       def build
         assn_name = attribute.to_sym
         class_name = options[:class_name] || attribute.to_s.classify
-        model.store_accessor :data, assn_name
+        model.store_accessor model.json_column, assn_name
         create_reader_for assn_name, class_name
         create_writer_for assn_name, class_name
         create_build_method_for assn_name, class_name
@@ -19,23 +19,23 @@ module ArDocStore
         create_embeds_many_attributes_method(class_name, assn_name)
         create_embeds_many_validation(assn_name)
       end
-      
+
       private
-      
+
       def add_method(method, block)
         model.class_eval do
           define_method method, block
         end
       end
-      
+
       def create_reader_for(assn_name, class_name)
         add_method assn_name.to_sym, -> {
           ivar = "@#{assn_name}"
           instance_variable_get(ivar) || begin
             my_class_name = class_name.constantize
-            items = read_store_attribute(:data, assn_name)
+            items = read_store_attribute(json_column, assn_name)
             if items.is_a?(Array) || items.is_a?(ArDocStore::EmbeddedCollection)
-              items = ArDocStore::EmbeddedCollection.new items.map { |item| my_class_name.build(item) }
+              items = ArDocStore::EmbeddedCollection.new items.map { |item| item.is_a?(my_class_name) ? item : my_class_name.build(item) }
             else
               items ||= ArDocStore::EmbeddedCollection.new
             end
@@ -60,10 +60,10 @@ module ArDocStore
             items = []
           end
           items.parent = self
-          instance_variable_set "@#{assn_name}", write_store_attribute(:data, assn_name, items)
+          instance_variable_set "@#{assn_name}", write_store_attribute(json_column, assn_name, items)
         }
       end
-      
+
       def create_build_method_for(assn_name, class_name)
         add_method "build_#{assn_name.to_s.singularize}", -> (attributes=nil) {
           assns = self.public_send assn_name
@@ -74,18 +74,18 @@ module ArDocStore
           item
         }
       end
-      
+
       def create_ensure_method_for(assn_name)
         method = -> { public_send "build_#{assn_name.to_s.singularize}" if self.public_send(assn_name).blank? }
         add_method "ensure_#{assn_name.to_s.singularize}", method
         add_method "ensure_#{assn_name}", method
       end
-      
+
       def create_embeds_many_attributes_method(class_name, assn_name)
         add_method "#{assn_name}_attributes=", -> (values) {
           return if values.blank?
           # if it's a single item then wrap it in an array but how to tell?
-          
+
           if values.respond_to?(:each)
             if values.respond_to?(:values)
               values = values.values
@@ -103,9 +103,9 @@ module ArDocStore
           validate_method = "validate_embedded_record_for_#{assn_name}"
           define_method validate_method, -> { validate_embeds_many assn_name }
           validate validate_method
-        end        
+        end
       end
-      
+
 
     end
 
@@ -113,7 +113,7 @@ module ArDocStore
       attr_reader :models, :assn_name, :parent, :class_name
       def initialize(parent, class_name, assn_name, models, values)
         @parent, @class_name, @assn_name, @models, @values = parent, class_name, assn_name, models, values
-        values.each { |value| 
+        values.each { |value|
           value = value.symbolize_keys
           if value.key?(:id)
             process_existing_model(value)
@@ -122,22 +122,22 @@ module ArDocStore
           end
         }
       end
-      
+
       private
-      
+
       attr_writer :models, :values
       attr_reader :values, :assn_name
-      
+
       def process_existing_model(value)
         return false unless value.key?(:id)
         model = find_model_by_value(value)
         model && destroy_or_update(model, value) or add(value)
       end
-      
+
       def destroy_or_update(model, value)
         destroy(model, value) or update_attributes(model, value)
       end
-      
+
       def add(value)
         models << class_name.constantize.new(value)
       end
@@ -145,15 +145,15 @@ module ArDocStore
       def destroy(model, value)
         wants_to_die?(value) && models.delete(model)
       end
-      
+
       def update_attributes(model, value)
         model.attributes = value
       end
-      
+
       def wants_to_die?(value)
         value.key?(:_destroy) && ArDocStore.convert_boolean(value[:_destroy])
       end
-      
+
       def find_model_by_value(value)
         models.detect { |item| item.id == value[:id] }
       end

data/lib/ar_doc_store/attribute_types/embeds_one_attribute.rb

@@ -15,7 +15,7 @@ module ArDocStore
         model.class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{attribute}
           @#{attribute} || begin
-            item = read_store_attribute :data, :#{attribute}
+            item = read_store_attribute json_column, :#{attribute}
             item = #{class_name}.build(item) unless item.is_a?(#{class_name})
             @#{attribute} = item
           end
@@ -29,7 +29,7 @@ module ArDocStore
           end
           value = #{class_name}.build value
           @#{attribute} = value
-          write_store_attribute :data, :#{attribute}, value
+          write_store_attribute json_column, :#{attribute}, value
         end
         CODE
       end
@@ -67,7 +67,7 @@ module ArDocStore
           validate :validate_embedded_record_for_#{attribute}
         CODE
       end
-      
+
     end
 
   end

data/lib/ar_doc_store/attribute_types/uuid_attribute.rb

@@ -7,17 +7,17 @@ module ArDocStore
       def build
         key = attribute.to_sym
         model.class_eval do
-          store_accessor :data, key
+          store_accessor json_column, key
           define_method key, -> {
-            value = read_store_attribute(:data, key)
+            value = read_store_attribute(json_column, key)
             unless value
               value = SecureRandom.uuid
-              write_store_attribute :data, key, value
+              write_store_attribute json_column, key, value
             end
             value
           }
           define_method "#{key}=".to_sym, -> (value) {
-            write_store_attribute(:data, key, value)
+            write_store_attribute(json_column, key, value)
           }
           add_ransacker(key, 'text')
         end

data/lib/ar_doc_store/embeddable_model.rb

@@ -21,17 +21,17 @@ module ArDocStore
 
         class_attribute :virtual_attributes
         self.virtual_attributes ||= HashWithIndifferentAccess.new
-        
+
         delegate :as_json, to: :attributes
-        
+
         attribute :id, :uuid
 
       end
 
     end
-    
+
     module InstanceMethods
-      
+
       def initialize(attrs=HashWithIndifferentAccess.new)
         @_initialized = true
         initialize_attributes attrs
@@ -61,7 +61,7 @@ module ArDocStore
         end
         self
       end
-      
+
       def persisted?
         false
       end
@@ -98,16 +98,16 @@ module ArDocStore
       end
 
     end
-    
+
     module ClassMethods
-      
+
       #:nodoc:
       def store_accessor(store, key)
         self.virtual_attributes ||= HashWithIndifferentAccess.new
         self.virtual_attributes = virtual_attributes.merge key =>  true
         key = key.to_sym
-        define_method key, -> { read_store_attribute(:data, key) }
-        define_method "#{key}=".to_sym, -> (value) { write_store_attribute :data, key, value }
+        define_method key, -> { read_store_attribute(json_column, key) }
+        define_method "#{key}=".to_sym, -> (value) { write_store_attribute json_column, key, value }
       end
 
       def build(attrs=HashWithIndifferentAccess.new)
@@ -124,4 +124,3 @@ module ArDocStore
 
   end
 end
-

data/lib/ar_doc_store/storage.rb

@@ -1,20 +1,26 @@
 module ArDocStore
   module Storage
-    
+
     def self.included(mod)
-      
+
+      mod.class_attribute :json_column
+      mod.json_column ||= :data
       mod.class_attribute :virtual_attributes
       mod.virtual_attributes ||= HashWithIndifferentAccess.new
-      
+
       mod.send :include, InstanceMethods
       mod.send :extend, ClassMethods
     end
-    
+
     module InstanceMethods
-      
+
+      def json_column
+        self.class.json_column
+      end
+
       def write_attribute(name, value)
         if is_stored_attribute?(name)
-          write_store_attribute :data, attribute_name_from_foreign_key(name), value
+          write_store_attribute json_column, attribute_name_from_foreign_key(name), value
         else
           super
         end
@@ -22,14 +28,14 @@ module ArDocStore
 
       def read_attribute(name)
         if is_stored_attribute?(name)
-          read_store_attribute :data, attribute_name_from_foreign_key(name)
+          read_store_attribute json_column, attribute_name_from_foreign_key(name)
         else
           super
         end
       end
 
       private
-      
+
       def is_stored_attribute?(name)
         name = name.to_sym
         is_store_accessor_method?(name) || name =~ /data\-\>\>/
@@ -37,7 +43,7 @@ module ArDocStore
 
       def is_store_accessor_method?(name)
         name = name.to_sym
-        self.class.stored_attributes[:data] && self.class.stored_attributes[:data].include?(name)
+        self.class.stored_attributes[json_column] && self.class.stored_attributes[json_column].include?(name)
       end
 
       def attribute_name_from_foreign_key(name)
@@ -58,9 +64,9 @@ module ArDocStore
         super clean_attribute_names_for_arel(attribute_names)
       end
     end
-    
+
     module ClassMethods
-      
+
       def attribute(name, *args)
         type = args.shift if args.first.is_a?(Symbol)
         options = args.extract_options!
@@ -147,8 +153,8 @@ module ArDocStore
         attribute field, options
       end
 
-    
+
     end
-    
+
   end
-end
+end

data/lib/ar_doc_store/version.rb

@@ -1,3 +1,3 @@
 module ArDocStore
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/test_helper.rb

@@ -45,8 +45,8 @@ class ARDuck
 
   def self.store_accessor(store, key)
     key = key.to_sym
-    define_method key, -> { read_store_attribute(:data, key) }
-    define_method "#{key}=".to_sym, -> (value) { write_store_attribute :data, key, value }
+    define_method key, -> { read_store_attribute(json_column, key) }
+    define_method "#{key}=".to_sym, -> (value) { write_store_attribute json_column, key, value }
   end
 
   def read_store_attribute(store, key)
@@ -113,7 +113,7 @@ class Restroom
   include ArDocStore::EmbeddableModel
   embeds_one :route
   embeds_one :door
-  
+
   enumerates :restroom_type, values: %w{single double dirty nasty clean}
 
   attribute :is_restroom_provided, as: :boolean
@@ -121,9 +121,9 @@ class Restroom
 
   embeds_one :stall_area_dimensions, class_name: 'Dimensions'
   embeds_one :sink_area_dimensions, class_name: 'Dimensions'
-  
+
   validates :restroom_type, presence: true
-  
+
 end
 
 class Building < ActiveRecord::Base
@@ -141,4 +141,3 @@ class Building < ActiveRecord::Base
   embeds_many :entrances
   embeds_many :restrooms
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_doc_store
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Furber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord