hash_serializer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6cf348b789ab8f2b2dea3a478b14ed8e641aff1
-  data.tar.gz: 5aa67c8330bd05d27a33f1dbc03bd4a85a273de1
+  metadata.gz: 3811178544221641ca9241597598ee9a9bacdc85
+  data.tar.gz: 951f34c4c7cebf51a944732d5f2bbb2f267ce545
 SHA512:
-  metadata.gz: 91cfa3a79393b29cee0238f98b99939174b5337df5b4f4ff8b3984cd87bc54a481e26ed399bbbabb6bb49eed3437b58ae96b88cac0e3e6a8c0691bce31468e83
-  data.tar.gz: 2af4cf496ca4e34b1962829335af462f983b747958b797128f407f428b36446874bad80efee49c5a71b8520b4a62d164ff4377ff5d95499d8515347a23483212
+  metadata.gz: 661653f86ee26f9ef0e1d88adcb71610a2c77a87cd16e6fc2c72367d86070ff40f87e0ebce6a3b9f69ae06192c037913b9160b87571effa25daf30a00b636cbb
+  data.tar.gz: b0ac3ca415d0d2eb24e210ff7a687aee1d57161ec724407c5de7090cf73adff2a8568b8a2c7b25eaf846236ae393506de92420ce9459fdb5ed181793fa4f08f1

data/README.md

@@ -29,11 +29,13 @@ Or install it yourself as:
 
 ## Usage
 
-In a model with a JSON column (ex - `billing_fields`) and serialize it:
+### HashSerializer::Serializer
+
+In a model with a JSON column (ex - `billing_fields`), use `HashSerializer::Serializer` serialize a Hash to JSON.
 
 ```ruby
 class Customer < ActiveRecord::Base
-  serialize :billing_fields, HashSerializer
+  serialize :billing_fields, HashSerializer::Serializer
 end
 ```
 
@@ -41,17 +43,23 @@ end
     $ customer.billing_fields[:name]
     => John C. Bland II
 
-This does leave the column open to any keys so it is great for development while equally terrible for security. You can utilize the `HashSerializer::Helpers` to add key validation:
+This leaves the column open to any structure you want so it is great for development while equally terrible for data integrity.
+
+### HashSerializer::Helpers
+
+You can utilize the `HashSerializer::Helpers` to add JSON key validation.
 
 ```ruby
 class Customer < ActiveRecord::Base
-  serialize :billing_fields, HashSerializer
+  include HashSerializer::Helpers
+
+  serialize :billing_fields, HashSerializer::Serializer
 
   validate :validate_billing_fields
 
   def validate_billing_fields
     invalid_keys = validate_hash_serializer :billing_hash, %w(name)
-    errors.add(:billing_fields, 'has invalid keys: #{invalid_fields.join(', ')}') unless invalid_keys.empty?
+    errors.add(:billing_fields, 'has invalid keys: #{invalid_fields.join(', ')}') unless invalid_keys.blank?
   end
 end
 ```
@@ -61,13 +69,15 @@ end
     $ customer.valid?
     => false
 
-Since some JSON keys may be best served with conflicting names to the housed model, you can also generate custom methods for each key for direct access to the hash without using hash syntax. It also allows for determining if a value has changed.
+Some JSON keys may conflict with names on the including model. You can also generate custom methods for each key for direct access to the hash without using hash syntax. It also allows for determining if a value has changed.
 
 ```ruby
 class Customer < ActiveRecord::Base
-  serialize :billing_fields, HashSerializer
+  include HashSerializer::Helpers
+
+  serialize :billing_fields, HashSerializer::Serializer
 
-  store_accessor_with_prefix :billing_fields, 'billing', %w(name)
+  hash_accessor_with_prefix :billing_fields, 'billing', %w(name)
 end
 ```
 
@@ -88,8 +98,6 @@ end
     $ customer.billing_fields_changed?
     => true
 
-**NOTE:** To hide the methods, you can include them in a Concern and call the included methods within the `included` block.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/hash_serializer.gemspec

@@ -30,4 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.39.0'
   spec.add_development_dependency 'simplecov', '~> 0.11.2'
   spec.add_development_dependency 'yard', '~> 0.8.7.6'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.11'
+  spec.add_development_dependency 'activerecord', '~> 4.2.6'
+  spec.add_development_dependency 'activerecord-nulldb-adapter', '~> 0.3.2'
 end

data/lib/hash_serializer/helpers.rb

@@ -1,88 +1,99 @@
+require 'active_support'
+
 module HashSerializer
   # Helper methods for generating methods from hash keys and validating keys
   module Helpers
-    # Validates a Postgres JSON hash on an ActiveRecord model does not include extra keys. It prevents user created
-    # data on JSON column types.
-    #
-    # Example:
-    #   >> validate_hash_serializer :billing_hash, %w(name address city state)
-    #
-    # @param hash_name [Symbol, String]
-    # @param valid_keys [Array]
-    #
-    # @return [Array] a sorted Array of the invalid keys
-    def validate_hash_serializer_keys(hash_name, valid_keys)
-      return if send(hash_name).nil? # || !send("#{hash_name}_changed?")
+    extend ActiveSupport::Concern
+
+    included do
+      # Validates a Postgres JSON hash on an ActiveRecord model does not include extra keys. It prevents user created
+      # data on JSON column types.
+      #
+      # Example:
+      #   >> validate_hash_serializer :billing_hash, %w(name address city state)
+      #
+      # @param hash_name [Symbol, String]
+      # @param valid_keys [Array]
+      #
+      # @return [Array] a sorted Array of the invalid keys
+      def validate_hash_serializer_keys(hash_name, valid_keys)
+        return if send(hash_name).nil? # || !send("#{hash_name}_changed?")
 
-      invalid_keys = send(hash_name).keys.map(&:to_s) - valid_keys.map(&:to_s)
-      return if invalid_keys.empty?
+        invalid_keys = send(hash_name).keys.map(&:to_s) - valid_keys.map(&:to_s)
+        return if invalid_keys.empty?
 
-      invalid_keys.sort
+        invalid_keys.sort
+      end
     end
 
-    # Creates ActiveRecord model methods for a Postgres JSON hash
-    #
-    # Example:
-    #   >> store_accessor_with_prefix :stripe_oauth_fields, 'stripe_connect', VALID_STRIPE_OAUTH_FIELDS
-    #
-    # @param hash [Hash]
-    # @param prefix [String] prefix for the generated methods
-    # @param keys [Array] array of strings to create methods
-    def hash_accessor_with_prefix(hash, prefix, *keys)
-      Array(keys).flatten.each do |key|
-        prefixed_key = "#{prefix}_#{key}"
+    # Helper methods available on the class
+    module ClassMethods
+      # Creates ActiveRecord model methods for a Postgres JSON hash
+      #
+      # Example:
+      #   >> hash_accessor_with_prefix :stripe_oauth_fields, 'stripe_connect', VALID_STRIPE_OAUTH_FIELDS
+      #
+      # @param hash_name [String | Symbol]
+      # @param prefix [String] prefix for the generated methods
+      # @param keys [Array] array of strings to create methods
+      def hash_accessor_with_prefix(hash_name, prefix, *keys)
+        Array(keys).flatten.each do |key|
+          prefixed_key = "#{prefix}_#{key}"
 
-        # Ex - billing_token=
-        create_setter_methods(hash, prefixed_key, key)
+          # Ex - billing_token=
+          create_setter_methods(hash_name, prefixed_key, key)
 
-        # Ex - billing_token
-        create_getters(hash, prefixed_key, key)
+          # Ex - billing_token
+          create_getters(hash_name, prefixed_key, key)
 
-        # Ex - billing_token_changed?
-        create_changed_methods(prefixed_key)
+          # Ex - billing_token_changed?
+          create_changed_methods(prefixed_key)
+        end
       end
-    end
 
-    protected
+      private
 
-    def create_method(name, &block)
-      self.class.send(:define_method, name, &block)
-    end
+      def create_method(name, &block)
+        send(:define_method, name, &block)
+      end
+
+      protected
 
-    # Creates setter methods with the prefixed name and adds @*_changed properties, if the value changed,
-    # and calls [hash]_will_change! to signify the hash has updated
-    #
-    # @param hash [Hash]
-    # @param prefixed_key [String] the hash key with the desired prefix
-    # @param key [String] the non-prefixed hash key
-    def create_setter_methods(hash, prefixed_key, key)
-      create_method("#{prefixed_key}=") do |value|
-        # Set a variable to track whether the value changed
-        instance_variable_set("@#{prefixed_key}_changed", true) if send(hash)[key] != value
+      # Creates setter methods with the prefixed name and adds @*_changed properties, if the value changed,
+      # and calls [hash]_will_change! to signify the hash has updated
+      #
+      # @param hash_name [String | Symbol]
+      # @param prefixed_key [String] the hash key with the desired prefix
+      # @param key [String] the non-prefixed hash key
+      def create_setter_methods(hash_name, prefixed_key, key)
+        create_method("#{prefixed_key}=") do |value|
+          # Set a variable to track whether the value changed
+          instance_variable_set("@#{prefixed_key}_changed", true) if send(prefixed_key) != value
 
-        # Store the value
-        send(hash)[key] = value
-        send("#{hash}_will_change!") if respond_to? "#{hash}_will_change!".to_sym
+          # Store the value
+          send(hash_name)[key] = value
+          send("#{hash_name}_will_change!") if respond_to? "#{hash_name}_will_change!".to_sym
+        end
       end
-    end
 
-    # Creates prefixed getter methods to access the hash value
-    #
-    # @param hash [Hash]
-    # @param prefixed_key [String] the hash key with the desired prefix
-    # @param key [String] the non-prefixed hash key
-    def create_getters(hash, prefixed_key, key)
-      create_method(prefixed_key) do
-        send(hash)[key]
+      # Creates prefixed getter methods to access the hash value
+      #
+      # @param hash_name [String | Symbol]
+      # @param prefixed_key [String] the hash key with the desired prefix
+      # @param key [String] the non-prefixed hash key
+      def create_getters(hash_name, prefixed_key, key)
+        create_method(prefixed_key) do
+          send(hash_name)[key]
+        end
       end
-    end
 
-    # Creates *_changed? methods referencing the @*_changed property created in create_setter_methods
-    #
-    # @param prefixed_key [String] the hash key with the desired prefix
-    def create_changed_methods(prefixed_key)
-      create_method("#{prefixed_key}_changed?") do
-        instance_variable_get("@#{prefixed_key}_changed") == true
+      # Creates *_changed? methods referencing the @*_changed property created in create_setter_methods
+      #
+      # @param prefixed_key [String] the hash key with the desired prefix
+      def create_changed_methods(prefixed_key)
+        create_method("#{prefixed_key}_changed?") do
+          instance_variable_get("@#{prefixed_key}_changed") == true
+        end
       end
     end
   end

data/lib/hash_serializer/version.rb

@@ -1,5 +1,5 @@
 # HashSerializer Version
 module HashSerializer
   # Current version
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/db/models.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+# Helper model for testing purposes
+class CustomerWithHash < ActiveRecord::Base
+  include HashSerializer::Helpers
+
+  VALID_KEYS = %w(name zipcode).freeze
+  INVALID_KEYS = %w(invalid keys).freeze
+  HASH_PREFIX = 'billing_stuff'.freeze
+
+  def initialize
+    super
+
+    @billing = {}
+  end
+
+  attr_writer(:billing)
+  attr_reader(:billing)
+
+  hash_accessor_with_prefix :billing, HASH_PREFIX, VALID_KEYS
+
+  def billing_will_change!
+  end
+end

data/spec/db/schema.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :customer_with_hashes, force: true do |t|
+    t.string :text
+  end
+end

data/spec/hash_serializer/helpers_spec.rb

@@ -1,31 +1,9 @@
 require 'spec_helper'
 
-# Helper model for testing purposes
-class HelpersTestModel
-  include HashSerializer::Helpers
-
-  def initialize(hash = {})
-    @hash = hash
-  end
-
-  def billing=(hash)
-    @hash = hash
-  end
-
-  def billing
-    @hash
-  end
-
-  def billing_will_change!
-  end
-end
-
 describe HashSerializer::Helpers do
   let(:hash) { { name: 'John C. Bland II', zipcode: 78_377 } }
 
-  subject { HelpersTestModel.new }
-  let(:valid_keys) { %w(name zipcode) }
-  let(:invalid_keys) { %w(invalid keys) }
+  subject { CustomerWithHash.new }
 
   context 'validate_hash_serializer_keys' do
     it 'should return invalid keys' do
@@ -33,66 +11,46 @@ describe HashSerializer::Helpers do
       hash['keys'] = false
 
       subject.billing = hash
-      expect(subject.validate_hash_serializer_keys(:billing, valid_keys)).to eq(invalid_keys)
+
+      errors = subject.validate_hash_serializer_keys(:billing, CustomerWithHash::VALID_KEYS)
+
+      expect(errors).to eq(CustomerWithHash::INVALID_KEYS)
     end
 
     it 'should return nil if no invalid keys exist' do
-      expect(subject.validate_hash_serializer_keys(:billing, valid_keys)).to be_nil
+      expect(subject.validate_hash_serializer_keys(:billing, CustomerWithHash::VALID_KEYS)).to be_nil
     end
   end
 
   context 'hash_accessor_with_prefix' do
-    let(:prefix) { 'billing_stuff' }
-
-    context 'not called' do
-      it 'setters do not exist' do
-        expect(subject.respond_to?(:billing_stuff_name=)).to be_falsey
-        expect(subject.respond_to?(:billing_stuff_zipcode=)).to be_falsey
-      end
-
-      it 'getters do not exist' do
-        expect(subject.respond_to?(:billing_stuff_name)).to be_falsey
-        expect(subject.respond_to?(:billing_stuff_zipcode)).to be_falsey
-      end
-
-      it 'changed? methods exist' do
-        expect(subject.respond_to?(:billing_stuff_name_changed?)).to be_falsey
-        expect(subject.respond_to?(:billing_stuff_zipcode_changed?)).to be_falsey
-      end
+    it 'setters exist' do
+      expect(subject.respond_to?(:billing_stuff_name=)).to be_truthy
+      expect(subject.respond_to?(:billing_stuff_zipcode=)).to be_truthy
     end
 
-    context 'called' do
-      before(:each) { subject.hash_accessor_with_prefix(:billing, prefix, valid_keys) }
-
-      it 'setters exist' do
-        expect(subject.respond_to?(:billing_stuff_name=)).to be_truthy
-        expect(subject.respond_to?(:billing_stuff_zipcode=)).to be_truthy
-      end
-
-      it 'getters exist' do
-        expect(subject.respond_to?(:billing_stuff_name)).to be_truthy
-        expect(subject.respond_to?(:billing_stuff_zipcode)).to be_truthy
-      end
+    it 'getters exist' do
+      expect(subject.respond_to?(:billing_stuff_name)).to be_truthy
+      expect(subject.respond_to?(:billing_stuff_zipcode)).to be_truthy
+    end
 
-      it 'changed? methods exist' do
-        expect(subject.respond_to?(:billing_stuff_name_changed?)).to be_truthy
-        expect(subject.respond_to?(:billing_stuff_zipcode_changed?)).to be_truthy
-      end
+    it 'changed? methods exist' do
+      expect(subject.respond_to?(:billing_stuff_name_changed?)).to be_truthy
+      expect(subject.respond_to?(:billing_stuff_zipcode_changed?)).to be_truthy
+    end
 
-      it 'methods works' do
-        new_name = 'John Bland III'
-        new_zipcode = 85_008
+    it 'methods works' do
+      new_name = 'John Bland III'
+      new_zipcode = 85_008
 
-        expect(subject).to receive(:billing_will_change!).twice
+      expect(subject).to receive(:billing_will_change!).twice
 
-        subject.billing_stuff_name = new_name
-        subject.billing_stuff_zipcode = new_zipcode
+      subject.billing_stuff_name = new_name
+      subject.billing_stuff_zipcode = new_zipcode
 
-        expect(subject.billing_stuff_name).to eq(new_name)
-        expect(subject.billing_stuff_name_changed?).to be_truthy
-        expect(subject.billing_stuff_zipcode).to eq(new_zipcode)
-        expect(subject.billing_stuff_zipcode_changed?).to be_truthy
-      end
+      expect(subject.billing_stuff_name).to eq(new_name)
+      expect(subject.billing_stuff_name_changed?).to be_truthy
+      expect(subject.billing_stuff_zipcode).to eq(new_zipcode)
+      expect(subject.billing_stuff_zipcode_changed?).to be_truthy
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+require 'active_record'
 
 SimpleCov.start
 SimpleCov.minimum_coverage 99
@@ -11,3 +12,10 @@ end
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'hash_serializer'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                        database: ':memory:',
+                                        schema: 'spec/db/schema.rb')
+
+load 'db/schema.rb'
+require 'db/models.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - John C. Bland II
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 description: A simple Hash to JSON serializer with some helpers to improve JSON model
   columns.
 email:
@@ -177,6 +219,8 @@ files:
 - lib/hash_serializer/helpers.rb
 - lib/hash_serializer/serializer.rb
 - lib/hash_serializer/version.rb
+- spec/db/models.rb
+- spec/db/schema.rb
 - spec/hash_serializer/helpers_spec.rb
 - spec/hash_serializer/serializer_spec.rb
 - spec/hash_serializer/version_spec.rb
@@ -208,6 +252,8 @@ specification_version: 4
 summary: A simple Hash to JSON serializer with some helpers to improve JSON model
   columns.
 test_files:
+- spec/db/models.rb
+- spec/db/schema.rb
 - spec/hash_serializer/helpers_spec.rb
 - spec/hash_serializer/serializer_spec.rb
 - spec/hash_serializer/version_spec.rb