digestible_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c596e6d31cb71e54906b8d6f8aa96bf319529f95eeb84facf867ed649b2bb37
+  data.tar.gz: 62b5ce599341143ac4c38484fab0fca9e2a5a3717d1b4d6251c5e257f5cf33be
+SHA512:
+  metadata.gz: 7c9359ada793b67094adb6382bd7745e2d129f61c9904cb3225de3db931556b890a4638bdd14e78422a6eb95b695eacfccabc18fea9eacd7cb67a91c37d012c7
+  data.tar.gz: 434d463ffac20945b973d3ed948e7594f99c5ae11f1eb7130f3472913e63f309a88e42abb33ccb3b731845e272e1288ce05f142d778fd77ced1d3cfe1d6d6a81

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+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,63 @@
+# DigestibleAttributes
+This plugin lets you compute a hash digest based on the
+values of a set of attributes, and store it on your model.
+
+## Usage
+
+### Options
+
+* `fields` - list of attribute fields to be digested
+* `algorithm` - which hash algorithm to use for digest (defaults to `:MD5`)
+* `digest_column` - where to store the digest (defaults to `*ALGORITHM*_digest`; i.e. `md5_digest`)
+
+### Quick start
+If you have a model with fields `foo`, `bar`, `baz`,
+simply add the following to your model file:
+
+```rb
+digestible_attributes fields: [:foo, :bar, :baz]
+```
+
+### Supported hash algorithms
+This gem uses `OpenSSL::Digest` to compute digests. The currently supported
+algorithms are:
+
+* `:MD2`
+* `:MD4`
+* `:MD5`
+* `:MDC2`
+* `:RIPEMD160`
+* `:SHA1`
+* `:SHA224`
+* `:SHA256`
+* `:SHA384`
+* `:SHA512`
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digestible_attributes'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install digestible_attributes
+```
+
+## Things to come
+- Generators
+- RSpec Matchers
+- Any ideas you might have?
+
+## Contributing
+For any suggested changes, you can fork the repo, make your changes, and then open up a PR.
+Please be sure to include a helpful commit message / explanation for your changes.
+
+## 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,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DigestibleAttributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/digestible_attributes.rb

@@ -0,0 +1,9 @@
+require 'active_support'
+require 'digestible_attributes/configuration'
+require 'digestible_attributes/railtie'
+
+module DigestibleAttributes
+  ActiveSupport.on_load(:active_record) do
+    extend DigestibleAttributes::Configuration
+  end
+end

data/lib/digestible_attributes/callback_actions.rb

@@ -0,0 +1,18 @@
+require 'digestible_attributes/digester'
+
+module DigestibleAttributes
+  module CallbackActions
+    extend ActiveSupport::Concern
+    include Digester
+
+    included do
+      before_save :set_digest_column
+    end
+
+    private
+
+    def set_digest_column
+      send("#{self.class.digest_column}=".to_sym, calculate_digest)
+    end
+  end
+end

data/lib/digestible_attributes/configuration.rb

@@ -0,0 +1,58 @@
+require 'digestible_attributes/callback_actions'
+require 'digestible_attributes/errors'
+
+module DigestibleAttributes
+  module Configuration
+    extend ActiveSupport::Concern
+
+    DIGEST_ALGORITHMS = %i(MD2 MD4 MD5 MDC2 RIPEMD160 SHA1 SHA224 SHA256 SHA384 SHA512)
+
+    cattr_accessor :digest_fields
+    cattr_accessor :digest_algorithm
+    cattr_accessor :digest_column
+
+    def digestible_attributes(options = {})
+      @@digest_fields = options.fetch(:fields, [])
+      @@digest_algorithm = options.fetch(:algorithm, :MD5)
+      @@digest_column = options.fetch(:digest_column, default_digest_column)
+
+      validate_configuration!
+
+      include CallbackActions
+    end
+
+    def default_digest_column
+      "#{@@digest_algorithm.downcase}_digest".to_sym
+    end
+
+    def validate_configuration!
+      validate_digest_fields!
+      validate_digest_algorithm!
+      validate_digest_column!
+    end
+
+    def validate_digest_fields!
+      if @@digest_fields & symbolized_columns != @@digest_fields
+        diff = @@digest_fields - symbolized_columns
+
+        raise Errors::DigestFieldError.new(diff)
+      end
+    end
+
+    def validate_digest_algorithm!
+      unless DIGEST_ALGORITHMS.include?(@@digest_algorithm)
+        raise Errors::DigestAlgorithmError.new(@@digest_algorithm)
+      end
+    end
+
+    def validate_digest_column!
+      unless symbolized_columns.include?(@@digest_column)
+        raise Errors::DigestColumnError.new(@@digest_column)
+      end
+    end
+
+    def symbolized_columns
+      self.column_names.map(&:to_sym)
+    end
+  end
+end

data/lib/digestible_attributes/digester.rb

@@ -0,0 +1,30 @@
+module DigestibleAttributes
+  module Digester
+    extend ActiveSupport::Concern
+
+    NULL_ESCAPE = "\u0000".freeze
+    FIELD_ESCAPE = "\uffef".freeze
+    FIELD_SEPARATOR = "\uffff".freeze
+
+    def calculate_digest
+      OpenSSL::Digest(self.class.digest_algorithm).hexdigest(digestible_string)
+    end
+
+    private
+
+    def symbolized_digest_fields
+      attributes.symbolize_keys.slice(*self.class.digest_fields)
+    end
+
+    def digestible_string
+      symbolized_digest_fields.map do |field, value|
+        base_str = "#{field}#{FIELD_ESCAPE}"
+        if value.nil?
+          base_str += NULL_ESCAPE
+        else
+          base_str += value.to_s
+        end
+      end.join(FIELD_SEPARATOR)
+    end
+  end
+end

data/lib/digestible_attributes/errors.rb

@@ -0,0 +1,33 @@
+module DigestibleAttributes
+  module Errors
+    class DigestFieldError < StandardError
+      def initialize(fields)
+        @fields = fields
+
+        super("invalid digest field(s): #{fields}")
+      end
+
+      attr_reader :fields
+    end
+
+    class DigestColumnError < StandardError
+      def initialize(column)
+        @column = column
+
+        super("invalid digest column: '#{column}'")
+      end
+
+      attr_reader :column
+    end
+
+    class DigestAlgorithmError < StandardError
+      def initialize(algorithm)
+        @algorithm = algorithm
+
+        super("invalid digest algorithm: '#{algorithm}'")
+      end
+
+      attr_reader :algorithm
+    end
+  end
+end

data/lib/digestible_attributes/railtie.rb

@@ -0,0 +1,4 @@
+module DigestibleAttributes
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/digestible_attributes/version.rb

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

data/lib/tasks/digestible_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :digestible_attributes do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: digestible_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Hernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: postgresql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.1
+description: 
+email:
+- ant@antfeedr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/digestible_attributes.rb
+- lib/digestible_attributes/callback_actions.rb
+- lib/digestible_attributes/configuration.rb
+- lib/digestible_attributes/digester.rb
+- lib/digestible_attributes/errors.rb
+- lib/digestible_attributes/railtie.rb
+- lib/digestible_attributes/version.rb
+- lib/tasks/digestible_attributes_tasks.rake
+homepage: https://www.github.com/hernanat/digestible_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.7.6
+signing_key: 
+specification_version: 4
+summary: Rails plugin for generating and storing hash digests based on model attributes
+test_files: []