column_namespace 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 851cc54004fb49af7ab29acf1b0adb5d887e54246397058aed37de7f3761b5f7
+  data.tar.gz: 18f116ac4a131c58a27aeea0baf575bc7e5c392ac1e4b667bc614b955d538bcb
+SHA512:
+  metadata.gz: 19e4d8ef5552f60155fe65ec73f0a704aa3e2d18b9311c06ecddce80fca924f6ae2c1a8e58f06d2b169d804264a759893e5ed80c03213d2adf3bac4f93258782
+  data.tar.gz: a6e06fd4d6a22db02df72eb27c5e6596888d0cfdf46b95011200bc5f34b91628177e59b147c3778671b537937a52d6fe87448248a6fe9ee8d4273d182c0252b2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,33 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+
+gemfile:
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
+  - gemfiles/6.0.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.3
+      gemfile: gemfiles/6.0.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/6.0.gemfile
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.gemfile
+
+notifications:
+  email: false

data/Appraisals

@@ -0,0 +1,24 @@
+appraise "4.2" do
+  gem "activerecord", "~> 4.2.11"
+  gem "sqlite3", "~> 1.3.6"
+end
+
+appraise "5.0" do
+  gem "activerecord", "~> 5.0.7"
+  gem "sqlite3", "~> 1.3.6"
+end
+
+appraise "5.1" do
+  gem "activerecord", "~> 5.1.7"
+  gem "sqlite3"
+end
+
+appraise "5.2" do
+  gem "activerecord", "~> 5.2.4"
+  gem "sqlite3"
+end
+
+appraise "6.0" do
+  gem "activerecord", "~> 6.0.2"
+  gem "sqlite3"
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in column_namespace.gemspec
+gemspec

data/README.md

@@ -0,0 +1,118 @@
+# Column Namespace
+
+[![Build Status](https://travis-ci.org/sshaw/column_namespace.svg?branch=master)](https://travis-ci.org/sshaw/column_namespace)
+
+Group columns on your Active Record model under a "namespace method".
+
+## Usage
+
+Given the following database table (note the columns beginning with `"external_"`):
+```sql
+create table products (
+  id int unsigned,
+  name varchar(255),
+  external_product_id bigint unsigned,
+  external_variant_id bigint unsigned,
+  external_metafield_id bigint unsigned
+)
+```
+
+Add the following to its model:
+```ruby
+class Product < ApplicationRecord
+  extend ColumnNamespace
+  column_namespace "external_"
+end
+```
+
+Now you can do:
+```ruby
+product = Product.new(:external => { :product_id => 123, :variant_id => 999 })
+
+p product.external.product_id  # 123
+p product.external.variant_id  # 999
+
+product.save!
+
+p product[:external_variant_id]  # 999
+
+product.external.variant_id = 21341510
+product.save!
+
+product[:external_variant_id]  # 21341510
+
+product = Product.last
+p product.external.to_h  # { :product_id => 1, :metafield_id => nil, ... }
+```
+
+Alternatively you can specify the namespace method and its columns:
+```ruby
+class Product < ApplicationRecord
+  extend ColumnNamespace
+  column_namespace :some_method => %w[name external_product_id]
+end
+```
+
+This gives you:
+```ruby
+product = Product.new(:some_method => { :name => "sshaw", :external_product_id => 99 })
+product.some_method.name = nil
+product.some_method.external_product_id = 1_000_00
+
+# etc... same stuff as before
+```
+
+
+### But Isn't This What `composed_of` Does‽
+
+Yes, but, no!
+
+`composed_of` forces you to create and explicitly use a "value object". In some cases (like in the above examples)
+this class is artificial. It doesn't exist in your domain –nor should it!
+
+Using the above examples with `composed_of` do not work. Instead of:
+```ruby
+product = Product.last
+product.external.product_id = 510
+product.save!  # does not save 510
+```
+
+You'd have to write:
+```ruby
+product = Product.last
+product.external = External.new(:product_id => 510)
+product.save!
+```
+
+The same applies for validation:
+```ruby
+# In Product:
+# validates :external_product_id, :numericality => { :greater_than => -1 }
+product = Product.last
+product.external.product_id = -1
+product.valid?  # true
+```
+
+You'd have to assign an instance of `External` to `product.external` for this to work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "column_namespace"
+```
+
+Or:
+
+```
+gem install column_namespace
+```
+
+## Author
+
+Skye Shaw [skye.shaw AT gmail.com]
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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/column_namespace.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "column_namespace/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "column_namespace"
+  spec.version       = ColumnNamespace::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Group columns on your Active Record model under a "namespace method".}
+  spec.homepage      = "https://github.com/sshaw/column_namespace"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "https://github.com/sshaw/column_namespace/issues"
+  spec.metadata["changelog_uri"] = "https://github.com/sshaw/column_namespace/blob/master/Changes"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "class2", "~> 0.5.2"
+  spec.add_dependency "activerecord", ">= 4.2", "< 7"
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/gemfiles/4.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.11"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/5.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.7"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/5.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.7"
+gem "sqlite3"
+
+gemspec path: "../"

data/gemfiles/5.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.4"
+gem "sqlite3"
+
+gemspec path: "../"

data/gemfiles/6.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.2"
+gem "sqlite3"
+
+gemspec path: "../"

data/lib/column_namespace.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "column_namespace/version"
+require "class2"
+
+module ColumnNamespace
+  def column_namespace(options)
+    if options.is_a?(Hash)
+      namespace_via_list(options)
+      return
+    end
+
+    Array.wrap(options).each { |prefix| namespace_via_prefix(prefix) }
+  end
+
+  private
+
+  def namespace_via_list(config)
+    config.each do |namespace, columns|
+      unknown = columns.map(&:to_s) - column_names
+      raise "unknown column(s): #{unknown.to_sentence}" unless unknown.empty?
+
+      klass = namespace.to_s.classify
+      class2 self, klass => columns
+
+      class_eval(<<-CODE)
+        def #{namespace}
+          @__#{namespace} ||= #{klass}.new(attributes.slice(*#{columns}))
+        end
+
+        def #{namespace}=(instance_or_attributes)
+          @__#{namespace} = instance_or_attributes.is_a?(Hash) ? #{klass}.new(instance_or_attributes) : instance_or_attributes
+        end
+
+        before_validation do
+          #{namespace}.to_h.each do |key, value|
+            self[key] = value
+          end
+        end
+      CODE
+    end
+  end
+
+  def namespace_via_prefix(prefix)
+    columns = column_names.select { |name| name.starts_with?(prefix) }
+    raise "No attributes found with prefix #{prefix}" unless columns.any?
+
+    method = prefix.sub(/[^[:alnum]]*\z/i, "")
+    klass  = method.classify
+    prefix_regex = /\A#{Regexp.quote(prefix)}[^[:alnum:]]*/
+
+    class2 self, klass => columns.map { |name| name.sub(prefix_regex, "") }
+
+    class_eval(<<-CODE)
+      def #{method}
+        @__#{method} ||= #{klass}.new(attributes.slice(*#{columns}).transform_keys! { |k| k.sub(/#{prefix_regex}/, "") })
+      end
+
+      def #{method}=(instance_or_attributes)
+        @__#{method} = instance_or_attributes.is_a?(Hash) ? #{klass}.new(instance_or_attributes) : instance_or_attributes
+      end
+
+      before_validation do
+        #{method}.to_h.each do |key, value|
+          self["#{prefix}\#{key}"] = value
+        end
+      end
+    CODE
+  end
+end

data/lib/column_namespace/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ColumnNamespace
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: column_namespace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: class2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- column_namespace.gemspec
+- gemfiles/4.2.gemfile
+- gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
+- gemfiles/5.2.gemfile
+- gemfiles/6.0.gemfile
+- lib/column_namespace.rb
+- lib/column_namespace/version.rb
+homepage: https://github.com/sshaw/column_namespace
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/column_namespace
+  bug_tracker_uri: https://github.com/sshaw/column_namespace/issues
+  changelog_uri: https://github.com/sshaw/column_namespace/blob/master/Changes
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Group columns on your Active Record model under a "namespace method".
+test_files: []