active_delegate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b11efe5cb6d1a9c223450f9da445ab5dd6743128
+  data.tar.gz: 2c24603c1415aa21e15d85fe405797b268a899a2
+SHA512:
+  metadata.gz: '08899cdfbc043b956ae5d626efb0ed17cc2fdca31d3642bc9dffd5a8bc09a91b9fd4e43e8bb94f441aaa5e196e8aeb92e0bc8967f20774225316d246e6a57a2f'
+  data.tar.gz: 669b8f94fe5b824cdff5647f0c0f7ab54efed63d763b9534b367d312036b6bb0138eeb92d8bddb5b801b2091c529acd9a5b36ff874ebdce3f67a5df58c3f71f6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_delegate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    active_delegate (0.1.0)
+      i18n (~> 0.8)
+      rails (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.1)
+      actionpack (= 5.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.1)
+      actionpack (= 5.1.1)
+      actionview (= 5.1.1)
+      activejob (= 5.1.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.1)
+      actionview (= 5.1.1)
+      activesupport (= 5.1.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.1)
+      activesupport (= 5.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.1)
+      activesupport (= 5.1.1)
+      globalid (>= 0.3.6)
+    activemodel (5.1.1)
+      activesupport (= 5.1.1)
+    activerecord (5.1.1)
+      activemodel (= 5.1.1)
+      activesupport (= 5.1.1)
+      arel (~> 8.0)
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubi (1.6.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.5)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.2)
+    nio4r (2.1.0)
+    nokogiri (1.7.2)
+      mini_portile2 (~> 2.1.0)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.1)
+      actioncable (= 5.1.1)
+      actionmailer (= 5.1.1)
+      actionpack (= 5.1.1)
+      actionview (= 5.1.1)
+      activejob (= 5.1.1)
+      activemodel (= 5.1.1)
+      activerecord (= 5.1.1)
+      activesupport (= 5.1.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.1.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.1)
+      actionpack (= 5.1.1)
+      activesupport (= 5.1.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_delegate!
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 jonian
+
+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,36 @@
+# ActiveDelegate
+
+Stores and retrieves delegatable data through attributes on a ActiveRecord class, with support for translatable attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_delegate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_delegate
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/active-delegate.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/active_delegate.rb

@@ -0,0 +1,22 @@
+require 'active_delegate/version'
+
+module ActiveDelegate
+  autoload :Associations, 'active_delegate/associations'
+  autoload :Attributes,   'active_delegate/attributes'
+
+  class << self
+    def included(model_class)
+      model_class.extend self
+    end
+  end
+
+  def delegate_associations(*args)
+    options = args.extract_options!
+    Associations.new(self, options)
+  end
+
+  def delegate_attributes(*args)
+    options = args.extract_options!
+    Attributes.new(self, options)
+  end
+end

data/lib/active_delegate/associations.rb

@@ -0,0 +1,70 @@
+module ActiveDelegate
+  class Associations
+    # Initialize assoctiations
+    def initialize(model, options)
+      @model   = model
+      @options = default_options.merge(options)
+
+      delegate_associations
+    end
+
+    private
+
+      # Get default options
+      def default_options
+        { except: [], only: [], allow_nil: false, to: [] }
+      end
+
+      # Get association reflection
+      def association_reflection
+        assoc_name = @options.fetch(:to)
+        reflection = @model.reflect_on_association(assoc_name)
+
+        return reflection unless reflection.nil?
+        raise "#{@model.name} don't have the association #{assoc_name}"
+      end
+
+      # Get model association class
+      def association_class
+        association_reflection.klass
+      end
+
+      # Get all associations
+      def association_reflections
+        association_class.reflect_on_all_associations
+      end
+
+      # Get singular model association names
+      def association_names
+        association_reflections.map(&:name)
+      end
+
+      # Get delegatable associations
+      def delegatable_associations
+        associations = association_names.map(&:to_sym)
+        associations = associations & @options[:only].to_a   if @options[:only].present?
+        associations = associations - @options[:except].to_a if @options[:except].present?
+
+        associations.map(&:to_sym)
+      end
+
+      # Check if association is collection
+      def collection_association?(association)
+        collections = association_reflections.select(&:collection?).map(&:name)
+        association.in? collections
+      end
+
+      # Delegate associations
+      def delegate_associations
+        options = { to: @options[:to], allow_nil: @options[:allow_nil] }
+
+        delegatable_associations.each do |association|
+          @model.delegate "#{association}",  options
+          @model.delegate "#{association}=", options
+
+          @model.delegate "#{association}_attributes=", options rescue true
+          @model.delegate "build_#{association}", options unless collection_association?(association)
+        end
+      end
+  end
+end

data/lib/active_delegate/attributes.rb

@@ -0,0 +1,119 @@
+module ActiveDelegate
+  autoload :ReadWrite, 'active_delegate/read_write'
+  autoload :Dirty,     'active_delegate/dirty'
+  autoload :Localized, 'active_delegate/localized'
+
+  class Attributes
+    # Initialize attributes
+    def initialize(model, options)
+      @model   = model
+      @options = default_options.merge(options)
+
+      build_association
+      delegate_attributes
+      save_delegated_attributes
+    end
+
+    private
+
+      # Get default options
+      def default_options
+        { except: [], only: [], allow_nil: false, to: [], prefix: nil, localized: false }
+      end
+
+      # Get association reflection
+      def association_reflection
+        assoc_name = @options.fetch(:to)
+        reflection = @model.reflect_on_association(assoc_name)
+
+        return reflection unless reflection.nil?
+        raise "#{@model.name} don't have the association #{assoc_name}"
+      end
+
+      # Get model association class
+      def association_class
+        association_reflection.klass
+      end
+
+      # Get association attribute names
+      def association_attribute_names
+        association_class.attribute_names
+      end
+
+      # Default excluded attributes
+      def default_excluded_attributes
+        assoc_as  = association_reflection.options[:as]
+        poly_attr = [:"#{assoc_as}_type", :"#{assoc_as}_id"] if assoc_as.present?
+
+        [:id, :created_at, :updated_at] + poly_attr.to_a
+      end
+
+      # Get delegatable attributes
+      def delegatable_attributes
+        attributes = association_attribute_names.map(&:to_sym)
+        attributes = attributes & @options[:only].to_a   if @options[:only].present?
+        attributes = attributes - @options[:except].to_a if @options[:except].present?
+        attributes = attributes - default_excluded_attributes
+
+        attributes.map(&:to_sym)
+      end
+
+      # Get localized delegatable attributes
+      def localized_attributes
+        attributes = delegatable_attributes
+        localized  = Localized.localized_methods(attributes) if @options[:localized].present?
+
+        localized.to_a.map(&:to_sym)
+      end
+
+      # Get delegatable methods
+      def delegatable_methods
+        attributes = delegatable_attributes + localized_attributes
+        readwrite  = ReadWrite.readwrite_methods(attributes)
+        dirty      = Dirty.dirty_methods(attributes)
+        methods    = readwrite + dirty
+
+        methods.map(&:to_sym)
+      end
+
+      # Delegate attributes
+      def delegate_attributes
+        options = { to: @options[:to], allow_nil: @options[:allow_nil], prefix: @options[:prefix] }
+        @model.delegate(*delegatable_methods, options)
+      end
+
+      # Build association method override
+      def build_association
+        @model.class.send :define_method, :"#{@options[:to]}" do
+          super || @model.send(:"build_#{@options[:to]}")
+        end
+      end
+
+      # Get prefixed attributes
+      def prefix_attributes(attributes)
+        if @options[:prefix].present?
+          prefix = @options[:prefix]
+          prefix = @options[:to] if prefix.is_a? TrueClass
+
+          attributes.map { |a| :"#{prefix}_#{a}" }
+        else
+          attributes
+        end
+      end
+
+      # Save delagated attributes in model class
+      def save_delegated_attributes
+        delegated = prefix_attributes(delegatable_attributes)
+        @model.send :define_singleton_method, :"#{@options[:to]}_attribute_names" do
+          delegated
+        end
+
+        if @options[:localized].present?
+          localized = prefix_attributes(localized_attributes)
+          @model.send :define_singleton_method, :"#{@options[:to]}_localized_attribute_names" do
+            localized
+          end
+        end
+      end
+  end
+end

data/lib/active_delegate/dirty.rb

@@ -0,0 +1,19 @@
+module ActiveDelegate
+  module Dirty
+    class << self
+      # Get dirty methods for attributes
+      def dirty_methods(attributes)
+        @dirty_methods = attributes.to_a.flat_map do |attribute|
+          method_suffixes.map { |suffix| "#{attribute}#{suffix}" }
+        end
+      end
+
+      # Get method suffixes
+      def method_suffixes
+        @method_suffixes ||= Class.new do
+          include ::ActiveModel::Dirty
+        end.attribute_method_matchers.map(&:suffix).select { |m| m =~ /\A_/ }
+      end
+    end
+  end
+end

data/lib/active_delegate/localized.rb

@@ -0,0 +1,26 @@
+require 'i18n'
+
+module ActiveDelegate
+  module Localized
+    class << self
+      # Get localized methods for attributes
+      def localized_methods(attributes)
+        @localized_methods = attributes.to_a.flat_map do |attribute|
+          method_suffixes.map { |suffix| "#{attribute}#{suffix}" }
+        end
+      end
+
+      # Get method suffixes
+      def method_suffixes
+        @method_suffixes ||= I18n.available_locales.map do |locale|
+          "_#{normalize_locale(locale)}"
+        end
+      end
+
+      # Normalize locale
+      def normalize_locale(locale)
+        "#{locale.to_s.downcase.sub("-", "_")}".freeze
+      end
+    end
+  end
+end

data/lib/active_delegate/read_write.rb

@@ -0,0 +1,17 @@
+module ActiveDelegate
+  module ReadWrite
+    class << self
+      # Get readwrite methods for attributes
+      def readwrite_methods(attributes)
+        @readwrite_methods = attributes.to_a.flat_map do |attribute|
+          method_suffixes.map { |suffix| "#{attribute}#{suffix}" }
+        end
+      end
+
+      # Get method suffixes
+      def method_suffixes
+        ['', '=', '?']
+      end
+    end
+  end
+end

data/lib/active_delegate/version.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: active_delegate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Stores and retrieves delegatable data through attributes on a ActiveRecord
+  class, with support for translatable attributes.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_delegate.rb
+- lib/active_delegate/associations.rb
+- lib/active_delegate/attributes.rb
+- lib/active_delegate/dirty.rb
+- lib/active_delegate/localized.rb
+- lib/active_delegate/read_write.rb
+- lib/active_delegate/version.rb
+homepage: https://github.com/hardpixel/active-delegate
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Delegate ActiveRecord model attributes and associations
+test_files: []