matterful_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab5c548e45b69263103845a1625c849bd03ce30a
+  data.tar.gz: 20b3d880f2911cd653f321d5ea0747e0b0bccc64
+SHA512:
+  metadata.gz: 637c48c60453952b52c801563f1ac45926aac456d0d88b5c1bcb2dd1b30f5d4e31a596e93e09b5397ee593583f646462e065cbb84c419bee4a3897e4ab9188e8
+  data.tar.gz: e2095a1958f80956e6d3d8f608ece71c36dbb70e0b859def9de1bfdf5f05fc161c3c033573e3928e7cda57249dae86d9cf43db47be437f0b5892a8358cd65818

data/.gitignore

@@ -0,0 +1,32 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick Gorbikoff
+
+MIT License
+
+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,27 @@
+matterful_attributes
+====================
+
+Ruby / Rails gem that shims ActiveRecord::Base to provide some helpful methods for parsing out attributes that matter to humans, i.e.
+``` Address.first.matterful_attributes ```
+will return a hash of attributes minus
+<b> id, type, polymorphic_id, polymorphic_type, cretated_at, updated_at</b> and can also skip all foreign_keys, like <b>category_id or status_id </b>.
+
+This is really useful when you need to be able to import, compare and update information on a record from an external source like a CSV file or a legacy DB. In that context only attributes specific to the model matter. In the world outside of rails, such as some old legacy DB these Rails specific attributes don't mean much. And I got tired of writing things like
+```ruby
+Address.first.attributes.except('id','created_at','updated_at').diff(OldStyleAddress.first.attributes)
+```
+It's much cleaner to right it this way:
+```ruby
+Address.first.matterful_diff(OldStyleAddress.first)
+```
+don't  you think?
+
+
+Production
+==========
+This was extracted from production code that's tested. However use at your own risk. NO warranties or guarantees provided!
+
+
+Tests
+=====
+This gem needs tests! It's tested in the context of my production code, but no gem specific tests. I'll add them later if time allows. Really bad practice, I know, but I'm really short on time.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/matterful_attributes/version.rb

@@ -0,0 +1,3 @@
+module MatterfulAttributes
+  VERSION = "0.0.1"
+end

data/lib/matterful_attributes.rb

@@ -0,0 +1,62 @@
+require "matterful_attributes/version"
+
+module MatterfulAttributes
+  module ActiveRecord
+    class Base
+
+      def matterful_attributes(options={})
+        options = options.dup
+        default     = options[:default].nil?        ? true : options[:default]
+        foreign_key = options[:foreign_key].nil?    ? true : options[:foreign_key]
+        sti         = options[:sti].nil?            ? true : options[:sti]
+        polymorphic = options[:polymorphic].nil?    ? true : options[:polymorphic]
+        # extra keys supplied as array of strings to ignore in comparison
+        attributes_to_ignore = options[:extra].nil? ? []   : options[:extra]
+
+        # Let's check for and add typical attributes that sti & polymorphic models have, override this by sti: false, polymorphic: false, :foreign_key: false
+        # by default when looking to compare two objects Customer.find(1).shipping_address.same_as? Address.new(city: 'Chicago')
+        # we really only want to see if any of the 'matterfule information changed', like address_line_1 or city.
+        # TODO: I guess I could do some smart checking on the model to see what kind of attributes it has. For now we'll just check for all that we want to remove
+        if default
+          attributes_to_ignore += ['id', 'created_at', 'updated_at']
+        end
+        if foreign_key
+          attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/_id\z/) && !k.match(/able_id\z/) }  # This will skipp polymorphic style foreign keys
+        end
+        if sti
+          attributes_to_ignore += ['type']
+        end
+        if polymorphic
+          attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/able_id\z/) }
+          attributes_to_ignore += attributes.keys.keep_if{|k| k.match(/able_type\z/) }
+        end
+        attributes.except(*attributes_to_ignore)
+      end
+
+      def same_as?(source,options={})
+        matterful_attributes(options) == source.matterful_attributes(options)
+      end
+
+      def matterful_diff(source,options={})
+        matterful_attributes(options).diff(source.matterful_attributes(options))
+      end
+
+      def matterful_update(source,options={})
+        # Update self if source object has new data but DO NOT save. Let's say you want to do futer processing on the new data. Validation, upcasing, concatination
+        if !(target_attributes = source.matterful_diff(self, options={})).empty?  # Pay attention to this! Reversing comparison to get expected results
+          target_attributes.each_pair do |k,v|
+            self[k] = v
+          end
+        end
+        self
+      end
+
+      def matterful_update!(source,options={})
+        # This will update self and save self if valid. Will return true or false.
+        self.matterful_update(source,options={})
+        save
+      end
+
+    end
+  end
+end

data/matterful_attributes.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matterful_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matterful_attributes"
+  spec.version       = MatterfulAttributes::VERSION
+  spec.authors       = ["Nick Gorbikoff"]
+  spec.email         = ["nick.gorbikoff@gmail.com"]
+  spec.description   = %q{Ruby / Rails gem that shims ActiveRecord::Base to provide some helpful methods for parsing out attributes that matter to humans, i.e. Address.first.matterful_attributes will return a hash of attributes minus id, type, polymorphic_id, polymorphic_type, cretated_at, updated_at and can also skip all foreign_keys, like category_id or status_id. }
+  spec.summary       = %q{See Readme.md}
+  spec.homepage      = "https://github.com/konung/matterful_attributes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: matterful_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Gorbikoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: 'Ruby / Rails gem that shims ActiveRecord::Base to provide some helpful
+  methods for parsing out attributes that matter to humans, i.e. Address.first.matterful_attributes
+  will return a hash of attributes minus id, type, polymorphic_id, polymorphic_type,
+  cretated_at, updated_at and can also skip all foreign_keys, like category_id or
+  status_id. '
+email:
+- nick.gorbikoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matterful_attributes.rb
+- lib/matterful_attributes/version.rb
+- matterful_attributes.gemspec
+homepage: https://github.com/konung/matterful_attributes
+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.0.3
+signing_key: 
+specification_version: 4
+summary: See Readme.md
+test_files: []
+has_rdoc: