inherited_class_var 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b3a4825303f3b5e5a3b941ce7a6c7fe45481b37
+  data.tar.gz: 6353e89d09cae6c90675b82ebaec3c99aced9cf4
+SHA512:
+  metadata.gz: 940ef48e70e3fcff95ccc8975ef7b8aa0c629738f4fc38fd184b4fa252f475247f4cbb844373d6995480d81c42c00e7a3ad9b2c87146d379073b1c07434224c1
+  data.tar.gz: d29c1cf3e940b328c3f76d3860a645086200400be261f3c3034825bfc9f3137763a89020ec968606d1213c45729cc9490a8cdfb52068609452c53f6bed890534

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+csv2hash

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.3
+  - ruby-head
+before_install: gem install bundler -v 1.10.6
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inherited_class_var.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joel AZEMAR
+
+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/README.md

@@ -0,0 +1,49 @@
+# InheritedClassVar
+
+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.
+
+[![Code Climate](https://codeclimate.com/github/joel/inherited_class_var.png)](https://codeclimate.com/github/joel/inherited_class_var)
+
+[![Dependency Status](https://gemnasium.com/joel/inherited_class_var.svg)](https://gemnasium.com/joel/inherited_class_var)
+
+[![Build Status](https://travis-ci.org/joel/inherited_class_var.svg?branch=master)](https://travis-ci.org/joel/inherited_class_var) (Travis CI)
+
+[![Coverage Status](https://coveralls.io/repos/joel/inherited_class_var/badge.svg?branch=master&service=github)](https://coveralls.io/github/joel/inherited_class_var?branch=master)
+
+[![Gem Version](https://badge.fury.io/rb/inherited_class_var.svg)](http://badge.fury.io/rb/inherited_class_var)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inherited_class_var'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inherited_class_var
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/UPGRADE.md

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'inherited_class_var'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inherited_class_var.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/inherited_class_var/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'inherited_class_var'
+  spec.version       = InheritedClassVar::VERSION
+  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.homepage      = 'https://github.com/FinalCAD/inherited_class_var'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  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 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.3'
+end

data/lib/inherited_class_var/invalid_options.rb

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

data/lib/inherited_class_var/version.rb

@@ -0,0 +1,3 @@
+module InheritedClassVar
+  VERSION = '0.1.0'
+end

data/lib/inherited_class_var.rb

@@ -0,0 +1,128 @@
+require 'inherited_class_var/version'
+
+require 'active_support/concern'
+# require 'active_support/core_ext/module/deprecation' # https://github.com/rails/rails/commit/1e62457a6d4307edc026591f8c8a8335d9627768
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext'
+require 'active_support/json'
+
+require 'inherited_class_var/invalid_options'
+
+module InheritedClassVar
+  extend ActiveSupport::Concern
+
+  included do
+    include InvalidOptions
+  end
+
+  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
+
+    # @param variable_name [Symbol] class variable name
+    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
+
+      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|
+        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)]
+    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
+    #
+    # grandparent has inherited_custom_class, but parent, doesn't.
+    #
+    # then: base_parent_class -> grandparent::inherited_custom_class -> self::inherited_custom_class
+    def inherited_custom_class(accessor_method_name, base_parent_class)
+      parent_class = inherited_ancestors[1..-1].find do |klass|
+        klass.respond_to?(accessor_method_name)
+      end.try(accessor_method_name)
+      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
+
+    # @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
+        value = default_value
+
+        inherited_ancestors.each do |ancestor|
+          ancestor_value = ancestor.instance_variable_get(variable_name)
+          value = ancestor_value.public_send(merge_method, value) if ancestor_value.present?
+        end
+
+        value
+      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
+
+    # 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
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: inherited_class_var
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Chung
+- Joel AZEMAR
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-04 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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Let inherited class var to authorize inheritance
+email:
+- hello@stevenchung.ca
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".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/version.rb
+homepage: https://github.com/FinalCAD/inherited_class_var
+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.6
+signing_key: 
+specification_version: 4
+summary: Let inherited class var
+test_files: []