inherited_class_var 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11b94c5852279a71dac8b6d886a9c15a536b9a8f
-  data.tar.gz: b2a9b2bc666ef7c34630363bd3d9ceaf98317e01
+  metadata.gz: 7e265f14ae462bf2896bb319cd5652912b583e13
+  data.tar.gz: cf4cc16e671cb1de045ebb1033677cb798fade78
 SHA512:
-  metadata.gz: 84e87a0974eaa0f97be23329bd79e1156bcf091db69bfcacc7a121136a2b5c0ffb1c3ea62d395dfa8febb9e5e7486b1617f89f7160b8c107c69bd754e9200ecc
-  data.tar.gz: 38873074a0667a0b75e0a2eb0c7bddc4a272f4c1a1431be6ee0be7ac3f8cabe7bd2ce16f26ca948a77acb597d8828d6808b5120f14b36b69913370feb102866d
+  metadata.gz: 5cd98dfc7200e8f5b4a1c911dcbe0ccb78568d0477d744d03762b6e2d52ae3765f0800fa50a56572fa5572e9476332a28076e6c0e4272c4095139a1addc9e15b
+  data.tar.gz: 965c29758a5896359733275d8faf86c9cfb30d8f8108e9b275fef11351af0c56f19d6b457bbde88d1b32f811c68cca5903900b4db2a5efd98af41134eca9070e

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/*

data/.rspec

@@ -1,3 +1,2 @@
 --color
---fail-fast
 --format documentation

data/Gemfile

@@ -3,6 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in inherited_class_var.gemspec
 gemspec
 
+gem "bundler", "> 1.3"
+gem "rake", "~> 10.0"
+
 group :test do
   gem 'rspec'
   gem 'coveralls'

data/inherited_class_var.gemspec

@@ -16,6 +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_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'activesupport',       '~> 4.2'
 end

data/lib/inherited_class_var/cache.rb

@@ -0,0 +1,54 @@
+#
+# 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

data/lib/inherited_class_var/version.rb

@@ -1,3 +1,3 @@
 module InheritedClassVar
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/inherited_class_var.rb

@@ -1,76 +1,44 @@
-require 'inherited_class_var/version'
-
-require 'active_support/concern'
-require 'active_support/dependencies/autoload'
-require 'active_support/core_ext'
-require 'active_support/json'
+require 'active_support/all'
 
-require 'inherited_class_var/invalid_options'
+require 'inherited_class_var/version'
+require 'inherited_class_var/cache'
 
 module InheritedClassVar
   extend ActiveSupport::Concern
 
-  included do
-    include InvalidOptions
-  end
+  include Cache
 
   class_methods do
-    # Clears the cache for a variable
-    # @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
 
+    #
+    # 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, options={})
-      options = check_and_merge_options(options, dependencies: [])
-
-      options[:dependencies].each do |dependency_name|
-        define_singleton_method dependency_name do
-          class_cache(hidden_variable_name(dependency_name)) do
-            send("_#{dependency_name}")
-          end
-        end
-      end
-
+    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, {}, :merge)
       end
 
-      define_singleton_method "merge_#{variable_name}" do |merge_value|
+      define_singleton_method :"merge_#{variable_name}" do |merge_value|
         value = instance_variable_get(hidden_variable_name) || instance_variable_set(hidden_variable_name, {})
-
         deep_clear_class_cache(hidden_variable_name)
-        options[:dependencies].each { |dependency_name| deep_clear_class_cache(hidden_variable_name(dependency_name)) }
-
         value.merge!(merge_value)
       end
     end
 
-    # @param variable_name [Symbol] class variable name based on
-    # @return [Symbol] the hidden variable name for class_cache
-    def hidden_variable_name(variable_name)
-      "@_#{variable_name}".to_sym
-    end
-
-    # @param included_module [Module] module to search for
-    # @return [Array<Module>] inherited_ancestors of included_module (including self)
-    def inherited_ancestors(included_module=InheritedClassVar)
-      included_model_index = ancestors.index(included_module)
-      included_model_index == 0 ? [included_module] : (ancestors[0..(included_model_index - 1)] - [InvalidOptions])
-    end
-
     # @param accessor_method_name [Symbol] method to access the inherited_custom_class
     # @param base_parent_class [Class] class that the custom class inherits from if there's no parent
     # @return [Class] a custom class with the inheritance following self. for example:
     #
     # grandparent -> parent -> self
     #
+    # we want self::inherited_custom_class to inherit from inherited_custom_class of all the ancestors
+    #
     # grandparent has inherited_custom_class, but parent, doesn't.
     #
     # then: base_parent_class -> grandparent::inherited_custom_class -> self::inherited_custom_class
@@ -86,46 +54,37 @@ module InheritedClassVar
       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 (recommend :@_variable_name)
     # @param default_value [Object] default value of the class variable
     # @param merge_method [Symbol] method to merge values of the class variable
     # @return [Object] a class variable merged across ancestors until inherited_class_module
     def inherited_class_var(variable_name, default_value, merge_method)
       class_cache(variable_name) do
-        current_value = default_value
-
-        ancestor_values = inherited_ancestors.map { |ancestor| ancestor.instance_variable_get(variable_name) }.compact
-
-        ancestor_values.each do |ancestor_value|
-          current_value = current_value.public_send(merge_method, ancestor_value)
-        end
-
-        current_value
+        inherited_ancestors.map { |ancestor| ancestor.instance_variable_get(variable_name) }
+          .compact
+          .reduce(default_value, merge_method)
       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
-
-    # 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
+    #
+    # More Helpers
+    #
 
-    # 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)
+    # @param included_module [Module] module to search for
+    # @return [Array<Module>] inherited_ancestors of included_module (including self)
+    def inherited_ancestors(included_module=InheritedClassVar)
+      included_model_index = ancestors.index(included_module)
+      included_model_index == 0 ? [included_module] : (ancestors[0..(included_model_index - 1)])
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inherited_class_var
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Chung
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,20 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-- !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: Let inherited class var to authorize inheritance
 email:
 - hello@stevenchung.ca
@@ -51,18 +37,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- UPGRADE.md
 - bin/console
 - bin/setup
 - inherited_class_var.gemspec
 - lib/inherited_class_var.rb
-- lib/inherited_class_var/invalid_options.rb
+- lib/inherited_class_var/cache.rb
 - lib/inherited_class_var/version.rb
 homepage: https://github.com/FinalCAD/inherited_class_var
 licenses:
@@ -84,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Let inherited class var

data/CHANGELOG.md

@@ -1,3 +0,0 @@
-### VERSION 0.1.0
-
-* Skeleton and first parsing

data/UPGRADE.md

@@ -1,3 +0,0 @@
-# Upgrading
-
-# Upgrading from xxx to xxx

data/lib/inherited_class_var/invalid_options.rb

@@ -1,13 +0,0 @@
-module InvalidOptions
-  extend ActiveSupport::Concern
-
-  class_methods do
-    protected
-    def check_and_merge_options(options, default_options)
-      invalid_options = options.keys - default_options.keys
-      raise ArgumentError.new("Invalid option(s): #{invalid_options}") if invalid_options.present?
-
-      options.reverse_merge(default_options)
-    end
-  end
-end