ar_doc_store 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 119e03286bb8ecf36dfa1d089075188a1979b1cb
-  data.tar.gz: fc1841751d938d5152c6b902c8925c5c25eac98e
+  metadata.gz: 362c4a4c014d334818371ebac25b31607a288644
+  data.tar.gz: 58896da6067be1c5a3cf1db37daefc6c9887fce6
 SHA512:
-  metadata.gz: fb2485d03e362542372b0a41e2fb4cde66c385731fefd3d437553e82f8c3637bca84ff63b46893a3ccef9be08de23bd299e1abfdac5356120fda85ffab411003
-  data.tar.gz: 4a0023a148212b537f2b07500641f138ecc870540bbe61c6c79e06ded4e3161fe8528d747ed5989809439399406997cb82550b603c89ad579ead55dd17911c8f
+  metadata.gz: a3becf0c88e32a96ad2fd7ff5422e828e53cd3a203485c2bfc19e657bf61ebb3236dbe89e1d2b0ffd0fe59de70cd8de28c8ad4a581040f3c2d02dfcb13985e4f
+  data.tar.gz: 2a668359a96d0085c2d37bcede71cd2da2962a1ec4cf334f921956c323b4e2fc53437c3a750f3b3055ff9fe92c7ed8b424babd1037df53fcd522008024388862

data/README.md

@@ -153,11 +153,11 @@ We probably have a form for the building, so here goes:
 ```ruby
 # in the controller:
 def new
-	@building = Building.new
+  @building = Building.new
 end
 
 def resource_params
-	params.require(:building).permit :name, :height, door_attributes: [:door_type]
+  params.require(:building).permit :name, :height, door_attributes: [:door_type]
 end
 
 # in the view, with a bonus plug for Slim templates:
@@ -205,10 +205,12 @@ Building.ransack name_cont: 'tall', height_lteq: 20
 
 ### Custom attribute types
 
-ArDocStore comes with several basic attribute types: array, boolean, enumeration, float, integer, and string. The implementation and extension points are inspired by SimpleForm. You can either create a new attribute type or overwrite an existing one. Forewarned is forestalled, maybe: as with SimpleForm, the custom input system is way easier to use if you were the one who built it, and it's still a little raw. Let's start with the implementation of :integer :
+ArDocStore comes with several basic attribute types: array, boolean, enumeration, float, integer, and string. The implementation and extension points are inspired by SimpleForm. You can either create a new attribute type or overwrite an existing one. Forewarned is forestalled, maybe: as with SimpleForm, the custom input system is way easier to use if you were the one who built it, and it's still a little raw.
+
+All attributes inherit from `AttributeTypes::BaseAttribute` and custom attributes are implemented by overriding that class's methods. Let's start with the implementation of `:integer` :
 
 ```ruby
-class IntegerAttribute < Base
+class IntegerAttribute < ArDocStore::AttributeTypes::BaseAttribute
   def conversion
     :to_i
   end
@@ -216,15 +218,20 @@ class IntegerAttribute < Base
   def predicate
     'int'
   end
+
+  def type
+    :number
+  end
 end
+
 ```
 
-Note that the data is getting put into a JSON column, so we want to make sure we get it out in the form that we want it. So the conversion method makes sure that it doesn't go in a integer and come back as a string. The predicate method tells postgres (via the ransacker) how to cast the JSON for searching.
+The data is put into a JSON column, so we want to make sure we serialize it correctly. The `conversion` method is a symbol or a string. It is called by the `dump` and `load` (in `BaseAttribute`) methods and is sent to the data when it is written and read. This makes sure that the data doesn't go in a integer and come back as a string. The `predicate` method tells Postgres (via the ransacker) how to cast the JSON for searching.
 
-Not all attribute types are that simple. Sometimes we have to put all the juice in the build method, and take care to define the getter and setter ourselves. In this example, we want to replace the boolean attribute with a similar boolean that can do Yes, No, and N/A, where N/A isn't simply nil but something the user has to choose. Here goes:
+Not all attribute types are that simple. Sometimes we have to put all the juice in the `build` method, and take care to define the getter and setter ourselves. In this example, we want to replace the boolean attribute with a similar boolean that can do Yes, No, and N/A, where N/A isn't simply nil but something the user has to choose. Here goes:
 
 ```ruby
-class BooleanAttribute < ArDocStore::AttributeTypes::Base
+class BooleanAttribute < ArDocStore::AttributeTypes::BaseAttribute
   def build
     key = attribute.to_sym
     model.class_eval do
@@ -260,6 +267,26 @@ class BooleanInput < SimpleForm::Inputs::CollectionRadioButtonsInput
 end
 ```
 
+#### What if I need different conversions for reading and writing?
+
+The `:datetime` attribute requires the data be cast to a string when written, but cast to a `Time` object when read. This overrides the `dump` and `load` methods instead. Here is the implementation:
+
+```ruby
+class DatetimeAttribute < ArDocStore::AttributeTypes::BaseAttribute
+  def type
+    :datetime
+  end
+
+  def dump
+    :to_time
+  end
+
+  def load
+    :to_s
+  end
+end
+```
+
 ## Roadmap
 1. Ransackers for embedded model attributes. Deliberately left out because when you have nested JSON, Postgres searches on any keys within the JSON become 10x slower.
 2. It would be nice if you could use the AR fluent query API on stored attributes, where is knows to replace, say, "name" with "data->>name" but I don't see how to do that, and Ransack provides a nice enough wrapper around ARel to get the job done another way.

data/Rakefile

@@ -16,6 +16,9 @@ namespace :test do
       create_table :buildings, force: true do |t|
         t.jsonb :data
       end
+      create_table :purchase_orders, force: true do |t|
+        t.jsonb :data
+      end
     end
   end
 end

data/lib/ar_doc_store.rb

@@ -17,6 +17,7 @@ module ArDocStore
     autoload :UuidAttribute, "ar_doc_store/attribute_types/uuid_attribute"
     autoload :EmbedsOneAttribute, "ar_doc_store/attribute_types/embeds_one_attribute"
     autoload :EmbedsManyAttribute, "ar_doc_store/attribute_types/embeds_many_attribute"
+    autoload :DatetimeAttribute, "ar_doc_store/attribute_types/datetime_attribute"
   end
 
   @mappings = Hash.new
@@ -27,6 +28,7 @@ module ArDocStore
   @mappings[:integer]     = 'ArDocStore::AttributeTypes::IntegerAttribute'
   @mappings[:string]      = 'ArDocStore::AttributeTypes::StringAttribute'
   @mappings[:uuid]        = 'ArDocStore::AttributeTypes::UuidAttribute'
+  @mappings[:datetime]    = 'ArDocStore::AttributeTypes::DatetimeAttribute'
 
   def self.mappings
     @mappings

data/lib/ar_doc_store/attribute_types/base_attribute.rb

@@ -20,15 +20,16 @@ module ArDocStore
       #:nodoc:
       def store_attribute
         attribute = @attribute
-        typecast_method = conversion
-        predicate = @predicate
+        predicate_method = predicate
         default_value = default
+        dump_method = dump
+        load_method = load
         model.class_eval do
-          add_ransacker(attribute, predicate)
+          add_ransacker(attribute, predicate_method)
           define_method attribute.to_sym, -> {
             value = read_store_attribute(json_column, attribute)
             if value
-              value.public_send(typecast_method)
+              value.public_send(load_method)
             elsif default_value
               write_default_store_attribute(attribute, default_value)
               default_value
@@ -38,15 +39,23 @@ module ArDocStore
             if value == '' || value.nil?
               write_store_attribute json_column, attribute, nil
             else
-              write_store_attribute(json_column, attribute, value.public_send(typecast_method))
+              write_store_attribute(json_column, attribute, value.public_send(dump_method))
             end
           }
         end
       end
 
+      def conversion
+        :to_s
+      end
 
+      def dump
+        conversion
+      end
 
+      def load
+        conversion
+      end
     end
-
   end
 end

data/lib/ar_doc_store/attribute_types/datetime_attribute.rb

@@ -0,0 +1,17 @@
+module ArDocStore
+  module AttributeTypes
+    class DatetimeAttribute < BaseAttribute
+      def type
+        :datetime
+      end
+
+      def load
+        :to_time
+      end
+
+      def dump
+        :to_s
+      end
+    end
+  end
+end

data/lib/ar_doc_store/storage.rb

@@ -81,8 +81,8 @@ module ArDocStore
       #:nodoc:
       def add_ransacker(key, predicate = nil)
         return unless respond_to?(:ransacker)
-        ransacker key do
-          sql = "(data->>'#{key}')"
+        ransacker key do |parent|
+          sql = "(#{parent.table[:data]}->>'#{key}')"
           if predicate
             sql = "#{sql}::#{predicate}"
           end

data/lib/ar_doc_store/version.rb

@@ -1,3 +1,3 @@
 module ArDocStore
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/attribute_types/datetime_attribute_test.rb

@@ -0,0 +1,35 @@
+require_relative './../test_helper'
+
+class DatetimeAttributeTest < MiniTest::Test
+
+  def test_attribute_on_model_init
+    approved_at = Time.new(1984, 3, 6)
+    po = PurchaseOrder.new approved_at: approved_at
+    assert approved_at == po.approved_at
+  end
+
+  def test_attribute_on_existing_model
+    approved_at = Time.new(1984, 3, 6)
+    po = PurchaseOrder.new
+    po.approved_at = approved_at
+    assert approved_at == po.approved_at
+    assert po.approved_at_changed?
+  end
+
+  def test_question_mark_method
+    approved_at = Time.new(1984, 3, 6)
+    po = PurchaseOrder.new approved_at: approved_at
+    assert_equal true, po.approved_at?
+  end
+
+  def test_conversion
+    approved_at = Time.new(1984, 3, 6)
+    po = PurchaseOrder.new approved_at: approved_at.to_s
+    assert_kind_of Time, po.approved_at
+  end
+
+  def test_no_op
+    po = PurchaseOrder.new
+    assert_nil po.approved_at
+  end
+end

data/test/test_helper.rb

@@ -141,3 +141,10 @@ class Building < ActiveRecord::Base
   embeds_many :entrances
   embeds_many :restrooms
 end
+
+class PurchaseOrder < ActiveRecord::Base
+  include ArDocStore::Model
+  attribute :name, :string
+  attribute :price, :float
+  attribute :approved_at, :datetime
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: ar_doc_store
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - David Furber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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'
 description: 'Provides an easy way to do something that is possible in Rails but still
@@ -76,7 +76,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,6 +86,7 @@ files:
 - lib/ar_doc_store/attribute_types/array_attribute.rb
 - lib/ar_doc_store/attribute_types/base_attribute.rb
 - lib/ar_doc_store/attribute_types/boolean_attribute.rb
+- lib/ar_doc_store/attribute_types/datetime_attribute.rb
 - lib/ar_doc_store/attribute_types/embeds_many_attribute.rb
 - lib/ar_doc_store/attribute_types/embeds_one_attribute.rb
 - lib/ar_doc_store/attribute_types/enumeration_attribute.rb
@@ -100,6 +101,7 @@ files:
 - lib/ar_doc_store/version.rb
 - test/attribute_types/array_attribute_test.rb
 - test/attribute_types/boolean_attribute_test.rb
+- test/attribute_types/datetime_attribute_test.rb
 - test/attribute_types/enumeration_attribute_test.rb
 - test/attribute_types/float_attribute_test.rb
 - test/attribute_types/integer_attribute_test.rb
@@ -118,23 +120,24 @@ 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.5.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A document storage gem meant for ActiveRecord PostgresQL JSON storage.
 test_files:
 - test/attribute_types/array_attribute_test.rb
 - test/attribute_types/boolean_attribute_test.rb
+- test/attribute_types/datetime_attribute_test.rb
 - test/attribute_types/enumeration_attribute_test.rb
 - test/attribute_types/float_attribute_test.rb
 - test/attribute_types/integer_attribute_test.rb