inherited_class_var 0.2.2 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7e840571a249a64b262bfc9bf8527a8035f9af1
-  data.tar.gz: 1af56f855f62cd025389c36691459142a2b3ef78
+  metadata.gz: c26fdce40dde8a1b5da981e01f10ac4c8a7c6fa3
+  data.tar.gz: 84f8404281c828b41232cf61e5f4bc8b60de8bd1
 SHA512:
-  metadata.gz: f2a1732a324a908fbe3b7dabed0a9a77dd27f75123158460e682d0d353bef9369bb2ba4f661eebc143330f9719110a3dd69f86bb19018c8389cbf46e29480ee0
-  data.tar.gz: ede1f603e5815b1f6da2c74fdd3cc3a7395b65600ff2f6b0586208d1fc732698058e76716365cf91ec525202be9081396be779f9e4e0bf8806668abb6feed2ce
+  metadata.gz: 097aedaabecfb5b04c235f89267167fda5a9ec45aca6c209befbce890cf8fcbeb824f46be58b8861e6625c29b689358fdf188678b13ee18cecac7f324aaeae38
+  data.tar.gz: 6a53d905f6f9cb5675a203775d68d56edc433d2283575881eb4bd8a4a96c3a8e1c8bebd57150e20153072848fde10c256f2d6991ae3087cadcc62e1d648bde94

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /.idea/*
+.byebug_history

data/README.md

@@ -1,17 +1,27 @@
-# InheritedClassVar
+# InheritedClassVar [![Build Status](https://travis-ci.org/FinalCAD/inherited_class_var.svg?branch=master)](https://travis-ci.org/FinalCAD/inherited_class_var)[![Code Climate](https://codeclimate.com/github/FinalCAD/inherited_class_var.png)](https://codeclimate.com/github/FinalCAD/inherited_class_var)[![Dependency Status](https://gemnasium.com/FinalCAD/inherited_class_var.svg)](https://gemnasium.com/FinalCAD/inherited_class_var)[![Coverage Status](https://coveralls.io/repos/FinalCAD/inherited_class_var/badge.svg?branch=master&service=github)](https://coveralls.io/github/FinalCAD/inherited_class_var?branch=master)[![Gem Version](https://badge.fury.io/rb/inherited_class_var.svg)](http://badge.fury.io/rb/inherited_class_var)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/inherited_class_var`. To experiment with that code, run `bin/console` for an interactive prompt.
+Implement class variables that inherit from their ancestors. Such as a `Hash`:
 
-[![Code Climate](https://codeclimate.com/github/FinalCAD/inherited_class_var.png)](https://codeclimate.com/github/FinalCAD/inherited_class_var)
-
-[![Dependency Status](https://gemnasium.com/FinalCAD/inherited_class_var.svg)](https://gemnasium.com/FinalCAD/inherited_class_var)
-
-[![Build Status](https://travis-ci.org/FinalCAD/inherited_class_var.svg?branch=master)](https://travis-ci.org/FinalCAD/inherited_class_var) (Travis CI)
+```ruby
+require 'inherited_class_var'
 
-[![Coverage Status](https://coveralls.io/repos/FinalCAD/inherited_class_var/badge.svg?branch=master&service=github)](https://coveralls.io/github/FinalCAD/inherited_class_var?branch=master)
+class Bird
+  include InheritedClassVar
+  inherited_class_hash :attributes #, shallow: false, reverse: false (default aoptions)
+  
+  def self.attribute(attribute_name, options={})
+    attributes_object.merge(attribute_name.to_sym => options)
+  end
+  attribute :name, upcase: true
+end
 
-[![Gem Version](https://badge.fury.io/rb/inherited_class_var.svg)](http://badge.fury.io/rb/inherited_class_var)
+class Duck < Bird
+  attribute :flying, default: false
+end
 
+Bird.attributes # => { name: upcase: true }
+Duck.attributes # => { name: upcase: true, flying: false }
+```
 
 ## Installation
 
@@ -31,70 +41,32 @@ Or install it yourself as:
 
 ## Usage
 
-You can follow this example, if you want to create Models with columns information and these informations still available after inheritance
-
-Create a Model module with `inherited_class_var`
-
-```
-require 'inherited_class_var'
-
-module Model
-  extend ActiveSupport::Concern
-
-  included do
-    include InheritedClassVar
-    inherited_class_hash :columns
-  end
+You can also define your own variable types. This is the source for `Hash`:
 
-  module ClassMethods
+```ruby
+module InheritedClassVar
+  class Hash < Variable
+    alias_method :merge, :change
 
-    protected
+    def default_value
+      {}
+    end
 
-    def column(column_name, options={})
-      merge_columns(column_name.to_sym => options)
+    def _change(hash1, hash2)
+      method = options[:shallow] ? :merge! : :deep_merge!
+      block = options[:reverse] ? Proc.new {|key,left,right| left }  : Proc.new {|key,left,right| right }
+      hash1.public_send(method, hash2, &block)
     end
   end
 end
-```
 
-`merge_columns` it's bring by `inherited_class_var`
-
-```
-class ModelBase
-  include Model
-
-  column :id, type: Integer
-end
-```
-
-Gives
-```
-ModelBase.columns # => {:id=>{:type=>Integer}}
-```
-
-```
-class UserModel < ModelBase
-
-  column :name, type: String
+module InheritedClassVar
+    def inherited_class_hash(variable_name, options={})
+      inherited_class_var variable_name, InheritedClassVar::Hash, options
+    end
 end
 ```
 
-Gives
-```
-UserModel.columns # => {:id=>{:type=>Integer}, :name=>{:type=>String}}
-```
-
-## 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.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/inherited_class_var. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/inherited_class_var.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Steve Chung', 'Joel AZEMAR']
   spec.email         = ['hello@stevenchung.ca','joel.azemar@gmail.com']
 
-  spec.summary       = %q{Let inherited class var}
-  spec.description   = %q{Let inherited class var to authorize inheritance}
+  spec.summary       = %q{Implement class variables that inherit from their ancestors.}
+  spec.description   = %q{Implement class variables that inherit from their ancestors.}
   spec.homepage      = 'https://github.com/FinalCAD/inherited_class_var'
   spec.license       = 'MIT'
 
@@ -16,5 +16,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport',       '~> 4.2'
+  spec.add_dependency 'activesupport', '>= 4.2'
 end

data/lib/inherited_class_var/hash.rb

@@ -0,0 +1,15 @@
+module InheritedClassVar
+  class Hash < Variable
+    alias_method :merge, :change
+
+    def default_value
+      {}
+    end
+
+    def _change(hash1, hash2)
+      method = options[:shallow] ? :merge! : :deep_merge!
+      block = options[:reverse] ? Proc.new {|key,left,right| left }  : Proc.new {|key,left,right| right }
+      hash1.public_send(method, hash2, &block)
+    end
+  end
+end

data/lib/inherited_class_var/variable.rb

@@ -0,0 +1,68 @@
+module InheritedClassVar
+  class Variable
+    attr_reader :name, :klass, :options
+
+    def initialize(name, klass, options={})
+      @name = name
+      @klass = klass
+      @options = options
+    end
+
+    def object_method_name
+      self.class.object_method_name(name)
+    end
+
+    def default_value
+      raise NotImplementedError
+    end
+
+    def raw_value
+      @raw_value ||= default_value
+    end
+
+    def value
+      @value ||= klass.inherited_ancestors
+        .map { |ancestor| ancestor.try(object_method_name).try(:raw_value) }
+        .compact
+        .reverse
+        .reduce(default_value, &method(:reduce))
+    end
+
+    def change(other_value)
+      notify_change
+      _change(raw_value, other_value)
+    end
+
+    def _change(value1, value2)
+      raise NotImplementedError
+    end
+    def reduce(*args); _change(*args) end
+
+    def notify_change
+      ([klass] + klass.descendants).each do |descendant|
+        descendant.try(object_method_name).try(:clear_memoized_value)
+      end
+    end
+
+    def clear_memoized_value
+      @value = nil if @value
+    end
+
+    class << self
+      def object_method_name(name)
+        :"#{name}_object"
+      end
+
+      def define_methods(name, klass, options={})
+        variable_class = self
+        object_method_name = object_method_name(name)
+
+        klass.send :define_singleton_method, object_method_name do
+          instance_variable_name = :"@#{object_method_name}"
+          instance_variable_get(instance_variable_name) || instance_variable_set(instance_variable_name, variable_class.new(name, self, options))
+        end
+        klass.send(:define_singleton_method, name) { public_send(object_method_name).value }
+      end
+    end
+  end
+end

data/lib/inherited_class_var/version.rb

@@ -1,3 +1,3 @@
 module InheritedClassVar
-  VERSION = '0.2.2'
+  VERSION = '1.0.0.beta1'
 end

data/lib/inherited_class_var.rb

@@ -1,39 +1,26 @@
 require 'active_support/all'
 
 require 'inherited_class_var/version'
-require 'inherited_class_var/cache'
+require 'inherited_class_var/variable'
+require 'inherited_class_var/hash'
 
 module InheritedClassVar
   extend ActiveSupport::Concern
 
-  include Cache
-
   class_methods do
     protected
 
-    #
-    # Easy Open API
-    #
-
     # @param variable_name [Symbol] class variable name
-    # @option options [Array] :dependencies array of dependent method names
-    def inherited_class_hash(variable_name)
-      hidden_variable_name = hidden_variable_name(variable_name)
-
-      define_singleton_method variable_name do
-        inherited_class_var(hidden_variable_name, {}) do |hash, to_merge|
-          hash.deep_merge!(to_merge) {|key,left,right| left } # a reverse_deep_merge! implementation, this will keep the parent's key order
-        end
-      end
-
-      define_singleton_method :"raw_#{variable_name}" do
-        class_var(hidden_variable_name, {})
-      end
+    # @param options [Hash] see InheritedClassVar::Hash
+    def inherited_class_hash(variable_name, options={})
+      inherited_class_var variable_name, InheritedClassVar::Hash, options
+    end
 
-      define_singleton_method :"merge_#{variable_name}" do |merge_value|
-        deep_clear_class_cache(hidden_variable_name)
-        public_send(:"raw_#{variable_name}").deep_merge!(merge_value)
-      end
+    # @param variable_name [Symbol] class variable name
+    # @param variable_class [Class] a InheritedClassVar::Variable class
+    # @param options [Hash] see the variable_class
+    def inherited_class_var(variable_name, variable_class, options={})
+      variable_class.define_methods(variable_name, self, options)
     end
 
     # @param accessor_method_name [Symbol] method to access the inherited_custom_class
@@ -54,43 +41,11 @@ module InheritedClassVar
       parent_class ||= base_parent_class
 
       klass = Class.new(parent_class)
-      # how else can i get the current scopes name...
       klass.send(:define_singleton_method, :name, &eval("-> { \"#{name}#{base_parent_class.name.demodulize}\" }"))
       klass
     end
 
-    #
-    # Helpers to make different types of inherited class variables
-    #
-
-    # @param variable_name [Symbol] class variable name based on
-    # @return [Symbol] the hidden variable name for class variable
-    def hidden_variable_name(variable_name)
-      :"@_#{variable_name}"
-    end
-
-    # @param variable_name [Symbol] class variable name
-    # @param default_value [Object] default value of the class variable
-    # @return [Object] a class variable of the specific class without taking into account inheritance
-    def class_var(variable_name, default_value)
-      instance_variable_get(variable_name) || instance_variable_set(variable_name, default_value)
-    end
-
-    # @param variable_name [Symbol] class variable name (recommend :@_variable_name)
-    # @return [Object] a class variable merged across ancestors until inherited_class_module
-    def inherited_class_var(variable_name, *reduce_args, &block)
-      class_cache(variable_name) do
-        inherited_ancestors.map { |ancestor| ancestor.instance_variable_get(variable_name) }
-          .compact
-          .reverse
-          .reduce(*reduce_args, &block)
-      end
-    end
-
-    #
-    # More Helpers
-    #
-
+    public
     # @param included_module [Module] module to search for
     # @return [Array<Module>] inherited_ancestors of included_module (including self)
     def inherited_ancestors(included_module=InheritedClassVar)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inherited_class_var
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Steve Chung
@@ -9,23 +9,23 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-description: Let inherited class var to authorize inheritance
+description: Implement class variables that inherit from their ancestors.
 email:
 - hello@stevenchung.ca
 - joel.azemar@gmail.com
@@ -46,7 +46,8 @@ files:
 - bin/setup
 - inherited_class_var.gemspec
 - lib/inherited_class_var.rb
-- lib/inherited_class_var/cache.rb
+- lib/inherited_class_var/hash.rb
+- lib/inherited_class_var/variable.rb
 - lib/inherited_class_var/version.rb
 homepage: https://github.com/FinalCAD/inherited_class_var
 licenses:
@@ -63,13 +64,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Let inherited class var
+summary: Implement class variables that inherit from their ancestors.
 test_files: []

data/lib/inherited_class_var/cache.rb

@@ -1,54 +0,0 @@
-#
-# Methods to help cache the inherited variable
-#
-# Given:
-# Parent -> Child
-#
-# and Parent.send(:inherited_class_hash, :some_var)
-#
-# Parent.merge_some_var(a: 1)
-# Child.some_var # => { a: 1 }, this requires going up the ancestors (Parent, Grandparent, etc.) and merging, so we cache the result
-# Child.some_var # => { a: 1 }, cached, no calculation
-#
-# Parent.merge_some_var(b: 2) # => this should clear the cache for all descendents
-# Child.some_var # => { a: 1, b: 2 } # => cache was cleared, so recalculate via merging up ancestors
-#
-module InheritedClassVar
-  module Cache
-    extend ActiveSupport::Concern
-
-    class_methods do
-
-      # Clears the cache for a variable (must be public)
-      # @param variable_name [Symbol] variable_name to cache against
-      def clear_class_cache(variable_name)
-        instance_variable_set inherited_class_variable_name(variable_name), nil
-      end
-
-      protected
-      # Memozies a inherited_class_variable_name
-      # @param variable_name [Symbol] variable_name to cache against
-      def class_cache(variable_name)
-        #
-        # equal to: (has @)inherited_class_variable_name ||= yield
-        #
-        cache_variable_name = inherited_class_variable_name(variable_name)
-        instance_variable_get(cache_variable_name) || instance_variable_set(cache_variable_name, yield)
-      end
-
-      # Clears the cache for a variable and the same variable for all it's dependant descendants
-      # @param variable_name [Symbol] variable_name to cache against
-      def deep_clear_class_cache(variable_name)
-        ([self] + descendants).each do |descendant|
-          descendant.try(:clear_class_cache, variable_name)
-        end
-      end
-
-      # @param variable_name [Symbol] variable_name to cache against
-      # @return [String] the cache variable name for the cache
-      def inherited_class_variable_name(variable_name)
-        :"#{variable_name}_inherited_class_cache"
-      end
-    end
-  end
-end