protected_record 0.0.0

data/.gitignore

@@ -0,0 +1,11 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+*.sw?
+.sw?

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+Just include in your tracked models:
+
+    include ProtectedRecord::ChangeRequest::Changeling
+    include ProtectedRecord::ChangeLog::Changeling
+
+and include in your user model:
+
+    include ProtectedRecord::ChangeRequest::Changer
+    include ProtectedRecord::ChangeLog::Changer
+
+then in your controller
+
+    # UseCase module will filter changes to protected_keys,
+    # creating a "change request" rather than applying changes
+
+    # UseCase module will allow other changes to be applied,
+    # creating a "change log" entry for the observed changes
+
+    update_result = ProtectedRecord::UseCase::Update.new({
+      params: visit_params,
+      protected_record: @patient_visit,
+      user: current_user,
+      protected_keys: %w{ visit_date do_not_resuscitate }
+    }).execute!
+
+    update_result.successful?
+
+and call methods like
+
+    @user.change_log_records
+    @user.change_request_records

data/lib/protected_record.rb

@@ -0,0 +1,5 @@
+require "protected_record/use_case/base"
+
+Dir.glob(File.join(File.dirname(__FILE__), '/**/*.rb')) do |c|
+  require(c)
+end

data/lib/protected_record/change_log.rb

@@ -0,0 +1,30 @@
+module ProtectedRecord
+  module ChangeLog
+    class Record < ActiveRecord::Base
+      self.table_name = "change_log_records"
+      attr_accessible :recordable, :user
+      belongs_to :recordable, polymorphic: true
+      belongs_to :user, class_name: "User", foreign_key: :user_id
+    end
+
+    # Include this module in models inheriting from AR::Base
+    module Changer
+      def self.included(base)
+        # Include this in AR models only
+        return unless base.ancestors.include?(ActiveRecord::Base)
+
+        base.has_many :change_log_records, class_name: "ProtectedRecord::ChangeLog::Record"
+      end
+    end
+
+    # Include this module in models inheriting from AR::Base
+    module Changeling
+      def self.included(base)
+        # Include this in AR models only
+        return unless base.ancestors.include?(ActiveRecord::Base)
+
+        base.has_many :change_log_records, as: :recordable, class_name: "ProtectedRecord::ChangeLog::Record"
+      end
+    end
+  end
+end

data/lib/protected_record/change_request.rb

@@ -0,0 +1,31 @@
+module ProtectedRecord
+  module ChangeRequest
+    class Record < ActiveRecord::Base
+      self.table_name = 'change_request_records'
+      attr_accessible :recordable, :user
+
+      belongs_to :recordable, polymorphic: true
+      belongs_to :user,       class_name: "User",
+        foreign_key: :user_id
+    end
+
+    module Changer
+      def self.included(base)
+        # Include this in models only
+        return unless base.ancestors.include?(ActiveRecord::Base)
+
+        base.has_many :change_request_records, class_name: "ProtectedRecord::ChangeRequest::Record"
+      end
+    end
+
+    module Changeling
+      def self.included(base)
+        # Include this in models only
+        return unless base.ancestors.include?(ActiveRecord::Base)
+
+        base.has_many :change_request_records, as: :recordable,
+          class_name: "ProtectedRecord::ChangeRequest::Record"
+      end
+    end
+  end
+end

data/lib/protected_record/use_case/base.rb

@@ -0,0 +1,21 @@
+module ProtectedRecord
+  module UseCase
+    class Base
+      def load_option(option, options)
+        instance_variable_set("@#{option}", options.fetch(option.to_sym) { raise "Missing required option: #{option}" } )
+     end
+
+      def load_options(*option_names, options)
+        option_names.each{|o| load_option(o, options) }
+        @errors ||= []
+      end
+
+      def errors
+        @errors
+      end
+    end
+  end
+end
+
+
+

data/lib/protected_record/use_case/change/change_log/create.rb

@@ -0,0 +1,43 @@
+module ProtectedRecord
+  module UseCase
+    module Change
+      module ChangeLog
+        class Create < ::ProtectedRecord::UseCase::Base
+          def initialize(options)
+            options = {
+              record_class: ::ProtectedRecord::ChangeLog::Record
+            }.merge!(options) if !options.has_key?(:record_class)
+
+            load_options(:record_class, :user, :changed_object, options) and validate_state
+          end
+
+          def execute!
+            create_change_log_record if @errors.empty?
+
+            if @errors.empty? && @record.save
+              return UseCase::Result.new(data: { change_log_record: @record })
+            else
+              return UseCase::Result.new(data: { change_log_record: @record }, errors: @errors)
+            end
+          end
+
+          private
+          def create_change_log_record
+            @record                   = @record_class.new
+            @record.user              = @user
+            @record.recordable        = @changed_object
+            @record.observed_changes  = ActiveSupport::JSON.encode(@changed_object.previous_changes)
+          end
+
+          protected
+          def validate_state
+            # What are we doing here, if not logging a change that has already happened?
+            if !@changed_object.previous_changes.present?
+              @errors << ActiveRecord::ActiveRecordError.new(':changed_object has no previous_changes')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/protected_record/use_case/change/change_request/create.rb

@@ -0,0 +1,51 @@
+module ProtectedRecord
+  module UseCase
+    module Change
+      module ChangeRequest
+        class Create < ::ProtectedRecord::UseCase::Base
+          def initialize(options)
+            options = {
+              record_class: ::ProtectedRecord::ChangeRequest::Record
+            }.merge!(options) if !options.has_key?(:record_class)
+
+            load_options(:protected_keys, :record_class, :user, :dirty_object, options) and validate_state
+          end
+
+          def execute!
+            return UseCase::Result.new(data: nil, success: true) if !requested_changes.present?
+
+            create_change_request_record if @errors.empty?
+
+            if @errors.empty? && @record.save
+              return UseCase::Result.new(data: { change_request_record: @record })
+            else
+              return UseCase::Result.new(data: { change_request_record: @record }, errors: @errors)
+            end
+          end
+
+          private
+          def create_change_request_record
+            @record                   = @record_class.new
+            @record.user              = @user
+            @record.recordable        = @dirty_object
+            @record.requested_changes = ActiveSupport::JSON.encode(requested_changes)
+          end
+
+          def requested_changes
+            @dirty_object.changes.select do |key|
+              @protected_keys.map(&:to_s).include? key.to_s
+            end
+          end
+
+          protected
+          def validate_state
+            # If there are no changes, there's no need to make a request
+            if !@dirty_object.changes.present?
+              @errors << ActiveRecord::ActiveRecordError.new(':dirty_object not dirty')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/protected_record/use_case/change/update.rb

@@ -0,0 +1,80 @@
+module ProtectedRecord
+  module UseCase
+    module Change
+      class Update < ::ProtectedRecord::UseCase::Base
+        def initialize(options)
+          # Defaults
+          options = {
+            change_request_use_case: UseCase::Change::ChangeRequest::Create,
+            change_log_use_case:     UseCase::Change::ChangeLog::Create
+          }.merge!(options) if !options.has_key?(:record_class)
+
+          load_options(:params, :protected_record, :change_request_use_case, :change_log_use_case, :protected_keys, :user, options)
+          validate_state
+        end
+
+        def execute!
+          form_change_request
+
+          if @errors.empty? && !@protected_record.changes.present?
+            return UseCase::Result.new(data: { params: @protected_record })
+          else
+            return UseCase::Result.new(data: { params: @protected_record }, errors: @errors)
+          end
+        end
+
+        private
+        def form_change_request
+          @protected_record.attributes = @params
+
+          unless @protected_record.id_was.nil?
+            request_result = @change_request_use_case.new(protected_keys: @protected_keys, dirty_object: @protected_record, user: @user).execute!
+            if request_result.successful?
+              revert_protected_attrs
+              save_protected_record
+            end
+          end
+        end
+
+        def revert_protected_attrs
+          @protected_keys.each do |key|
+            if @protected_record.send("#{key.to_s}_changed?")
+              @protected_record.send("#{key.to_s}=", @protected_record.send("#{key.to_s}_was"))
+            end
+          end
+
+          raise if @protected_keys.any? { |key| @protected_record.send("#{key}_changed?") }
+        end
+
+        def save_protected_record
+          @protected_record.save
+          log_changes
+        end
+
+        def log_changes
+          log_result = @change_log_use_case.new(user: @user, changed_object: @protected_record).execute!
+          return true if log_result.successful?
+        end
+
+        protected
+        def validate_state
+          # We expect some keys
+          if !@protected_keys.kind_of?(Array)
+            @errors << TypeError.new(':protected_keys not kind of Array')
+          end
+
+          # The keys should respond to to_s
+          if @protected_keys.any? {|el| !el.respond_to?("to_s") }
+            @errors << TypeError.new('All :protected_keys should respond to #to_s')
+          end
+
+          # The dirty_object should respond to all keys (as methods)
+          @protected_keys.each do |key|
+            error = ActiveRecord::ActiveRecordError.new(":dirty_object must respond to #{key.to_s}")
+            @errors << error unless @protected_record.respond_to?(key.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/protected_record/use_case/result.rb

@@ -0,0 +1,40 @@
+module ProtectedRecord
+  module UseCase
+    class Result
+      # The response from a use case execution
+      #
+      # Every use case should return a Result after it runs.
+      #
+      # @param [options] options_hash
+      # A hash specifying the appropriate options
+      #
+      # @return [UseCase::Result]
+      # the Result instance
+      #
+      # @example
+      # UseCase::Result.new(success: true, data: {})
+      # # => <UseCase::Result>
+      #
+      # @api public
+      def initialize(options)
+        @success = options.fetch(:success) { !options[:errors].present? }
+        @errors = options[:errors]
+        @data = options[:data]
+      end
+
+      # @api public
+      def successful?
+        !!@success
+      end
+
+      def errors
+        @errors
+      end
+
+      # @api public
+      def data
+        @data
+      end
+    end
+  end
+end

data/lib/protected_record/version.rb

@@ -0,0 +1,3 @@
+module ProtectedRecord
+  VERSION = "0.0.0"
+end

data/protected_record.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "protected_record/version"
+
+Gem::Specification.new do |s|
+  s.name        = "protected_record"
+  s.version     = ProtectedRecord::VERSION
+  s.authors     = ["Tad Hosford"]
+  s.email       = ["tad.hosford@gmail.com"]
+  s.homepage    = "http://github.com/rthbound/protected_record"
+  s.description = %q{
+                      Filters changes & logs changes to protected records.
+                      Creates change requests when changes are attempted on protected attrs
+                    }
+  s.summary     = %q{  }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,12 @@
+# Testing frameworks
+require "minitest/spec"
+require "minitest/autorun"
+
+# Debugger
+require "pry"
+
+# The gem
+$: << File.dirname(__FILE__) + "/../lib"
+$: << File.dirname(__FILE__)
+
+require "protected_record"

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: protected_record
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.0
+platform: ruby
+authors:
+- Tad Hosford
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: ! "\n                      Filters changes & logs changes to protected\
+  \ records.\n                      Creates change requests when changes are attempted\
+  \ on protected attrs\n                    "
+email:
+- tad.hosford@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/protected_record.rb
+- lib/protected_record/change_log.rb
+- lib/protected_record/change_request.rb
+- lib/protected_record/use_case/base.rb
+- lib/protected_record/use_case/change/change_log/create.rb
+- lib/protected_record/use_case/change/change_request/create.rb
+- lib/protected_record/use_case/change/update.rb
+- lib/protected_record/use_case/result.rb
+- lib/protected_record/version.rb
+- protected_record.gemspec
+- test/minitest_helper.rb
+homepage: http://github.com/rthbound/protected_record
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: ''
+test_files: []