has_json_attributes_on 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d72de8b5fe0ad71e4e6ccc7ba63a7a708916516
+  data.tar.gz: e4ffdff6fc8e9886df9a8e80b7b9c00bc43994a7
+SHA512:
+  metadata.gz: f9052ae90b3e913af9aafa1689c28fe7dc1af741228e48310c6b87f6f35f73784011d0e61c36aa7dd1bd6e8d3f4788030a993c596926f1c30cffcbf7902279bf
+  data.tar.gz: 3e148c926b5c3f564229e5bf6f6990271ac62cda03648617789056a89376f74a34393deff32395cad9d28efe1f64e81b9ac2b014dd24921869e836e23e1e5e32

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 wiseallie
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasJsonAttributesOn'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/has_json_attributes_on/version.rb

@@ -0,0 +1,3 @@
+module HasJsonAttributesOn
+  VERSION = "0.0.1"
+end

data/lib/has_json_attributes_on.rb

@@ -0,0 +1,204 @@
+require 'rails'
+require 'active_record/connection_adapters/postgresql/oid/json'
+require 'active_record/connection_adapters/postgresql/oid/jsonb'
+require  'virtus'
+require  'default_value_for'
+
+module HasJsonAttributesOn
+  extend ActiveSupport::Concern
+
+  AXIOMS = {
+    'Boolean' => Axiom::Types::Boolean,
+    'String'  => Axiom::Types::String,
+    'Decimal' => Axiom::Types::Decimal,
+    'Date'    => Axiom::Types::Date,
+    'DateTime'=> Axiom::Types::DateTime,
+    'Time'    => Axiom::Types::Time,
+    'Float'   => Axiom::Types::Float,
+    'Integer' => Axiom::Types::Integer,
+    'Object'  => Axiom::Types::Object,
+    'Array'   => Axiom::Types::Array,
+    'Set'     => Axiom::Types::Set,
+    'Hash'    => Axiom::Types::Hash
+  }
+
+  SUPPORTED_DB_SQL_TYPES = %w(json jsonb)
+  VALUE_TYPE_CLASSES = {
+    'json' => 'HasJsonAttributesOn::Type::Json',
+    'jsonb' => 'HasJsonAttributesOn::Type::Jsonb'
+  }
+
+  module Type
+    module JsonType
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :virtus_model
+      end
+
+      class_methods do
+
+        def validate_virtus_model_attr_options!(model, attrs)
+          raise "Model: #{model}, attributes must be a Hash of key:attribute_name and value:attribute_type" unless attrs.is_a?(Hash)
+          attrs.each do |k,v|
+            raise "Model: #{model}, key:#{k} should be a valid hash key" if k.to_s.include?(" ");
+            raise "Model: #{model}, value for key:#{k} should be one of: #{AXIOMS.keys}" unless v.in?(AXIOMS.keys)
+          end
+        end
+
+        def build_virtus_model(model, data_column, attrs = {})
+          validate_virtus_model_attr_options!(model, attrs)
+          klazz_name = data_column.to_s.camelize + "DynamicType"
+
+          klazz = Class.new do
+            include Virtus.model
+
+            attrs.each do |attr_name, attr_type_key|
+              attribute attr_name.to_sym, AXIOMS[attr_type_key]
+            end
+
+            def self.inspect
+              _attrs = attribute_set.instance_variable_get("@attributes").map{|x| [x.name, x.type.inspect].join(":")}.join(", ")
+              "<#{name}  type =>HasJsonAttributesOn::Type::JsonType  attribute_set => [#{_attrs}]>"
+            end
+
+            def self.to_s
+              self.inspect
+            end
+          end
+
+          return model.send(:const_set, klazz_name, klazz)
+        end
+      end
+
+      def initialize(model, data_column, attrs = {})
+        @virtus_model = self.class.build_virtus_model(model, data_column, attrs)
+      end
+
+      def type_cast_from_user(value)
+        @virtus_model.new(value)
+      end
+
+      def type_cast_from_database(value)
+        @virtus_model.new(super(value))
+      end
+
+      def type_cast_for_database(value)
+        if value.is_a?(@virtus_model)
+          ::ActiveSupport::JSON.encode(value)
+        else
+          super
+        end
+      end
+    end
+    class Jsonb < ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb
+      include JsonType
+    end
+    class Json < ::ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json
+      include JsonType
+    end
+  end
+
+  included do
+    extend Forwardable
+  end
+
+  class_methods do
+
+    def inherited(subclass)
+      super
+      if self.respond_to?(:has_json_attributes_on) && self.respond_to?(:_json_attributes_on) && self._json_attributes_on.present?
+        self._json_attributes_on.each do |data_column, options|
+          subclass.has_json_attributes_on(data_column, options[:accessors])
+        end
+      end
+    end
+
+    def has_json_attributes_on(data_column = :data, accessors = {})
+      validated_data_column, data_column_sql_type = validate_json_attributes_data_column!(data_column)
+      validated_accessors = validate_dynamic_accessors!(accessors)
+      build_json_attributes(validated_data_column, data_column_sql_type, validated_accessors)
+    end
+
+    private
+
+    def validate_json_attributes_data_column!(data_column)
+      data_column = data_column.to_sym
+      unless columns.map(&:name).include?(data_column.to_s)
+        raise ArgumentError,  "Model: #{name}#has_json_attributes_on, data_column: #{data_column} does not exist as a column in database"
+      end
+
+      data_column_sql_type = columns.detect{|x| x.name.to_s == data_column.to_s}.sql_type
+      unless data_column_sql_type.in?(SUPPORTED_DB_SQL_TYPES)
+        raise ArgumentError,  "Model: #{name}#has_json_attributes_on, data_column: #{data_column} is of sql type: #{data_column_sql_type}, supported types are:#{SUPPORTED_DB_SQL_TYPES}"
+      end
+      return [data_column, data_column_sql_type]
+    end
+
+
+    def validate_dynamic_accessors!(accessors)
+      raise ArgumentError, "Model: #{name}#has_json_attributes_on, accessors must be a hash" unless accessors.is_a?(Hash)
+      accessors = accessors.symbolize_keys
+      accessors.each do |k,v|
+        if columns.map(&:name).include?(k.to_s)
+          raise ArgumentError, "Model: #{name}#has_json_attributes_on, accessor key:#{k} has already been defined as the model column"
+        end
+
+        begin
+          v.assert_valid_keys(:type, :validates, :default)
+        rescue Exception => e
+          raise ArgumentError, "Model: #{name}#has_json_attributes_on, accessor key:#{k}, #{e.message}"
+        end
+      end
+      return accessors
+    end
+
+    def build_json_attributes(data_column, data_column_sql_type, accessors)
+      cattr_accessor :_json_attributes_on
+      self._json_attributes_on ||= {}.symbolize_keys
+      self._json_attributes_on[data_column] ||= {
+        accessors: {},
+        types: {},
+        default_values: {},
+        validations: {},
+        delegators: [],
+        data_column_sql_type: data_column_sql_type,
+        value_type_class: VALUE_TYPE_CLASSES[data_column_sql_type].constantize,
+        value_type_instance: nil
+      }.symbolize_keys
+
+      self._json_attributes_on[data_column][:accessors].merge!(accessors)
+
+      accessors.each do |_accessor_attribute, options|
+        self._json_attributes_on[data_column][:validations][_accessor_attribute] = options[:validates] if options[:validates]
+        self._json_attributes_on[data_column][:default_values][_accessor_attribute] = options[:default]
+        self._json_attributes_on[data_column][:types][_accessor_attribute] = options[:type] || 'String'
+        self._json_attributes_on[data_column][:delegators] += [_accessor_attribute, "#{_accessor_attribute.to_s}=".to_sym]
+      end
+
+      # set attribute for this class
+      self._json_attributes_on[data_column][:value_type_instance] = self._json_attributes_on[data_column][:value_type_class].new(self, data_column, self._json_attributes_on[data_column][:types])
+      attribute data_column, self._json_attributes_on[data_column][:value_type_instance]
+
+      # set the delegators
+      def_delegators data_column, *self._json_attributes_on[data_column][:delegators]
+
+      # set default values
+      self._json_attributes_on[data_column][:default_values].each do |_accessor_attribute, _default_value|
+        if _default_value.is_a?(Proc)
+          default_value_for(_accessor_attribute, &_default_value)
+        else
+          default_value_for _accessor_attribute, _default_value
+        end
+      end
+
+      # set validations
+      self._json_attributes_on[data_column][:validations].each do |_accessor_attribute, _attribute_validations|
+        validates _accessor_attribute, _attribute_validations
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, HasJsonAttributesOn)

data/lib/tasks/has_json_attributes_on_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_json_attributes_on do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: has_json_attributes_on
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- wiseallie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: default_value_for
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+description: Only supports Postgresql JSON & JSONB columns at the moment
+email:
+- wiseallie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/has_json_attributes_on.rb
+- lib/has_json_attributes_on/version.rb
+- lib/tasks/has_json_attributes_on_tasks.rake
+homepage: https://github.com/wiseallie/has_json_attributes_on
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: 'ActiveRecord: Gives the ability to store attributes in one JSON or JSONB
+  column in the database and provides validations, typecasting and default values
+  on the accessors'
+test_files: []
+has_rdoc: