lanes 0.1.0 → 0.1.2

data/lib/lanes/concerns/locked_fields.rb

@@ -1,84 +0,0 @@
-module Lanes
-    module Concerns
-
-        # @see ClassMethods
-        module LockedFields
-            extend ActiveSupport::Concern
-
-            module ClassMethods
-                # Mark fields as locked, meaning they cannot be updated by using the
-                # regular attribute update methods.  Instead it must be called in an unlock block
-                # Relies on attr_readonly internally
-                #
-                # Is used to designate sensitive fields that we want to make sure someone's thought about before updating
-                # Also solves the age old single equals vs double equals bug/typo.
-                #
-                #     class BankAccount < Lanes::Model
-                #
-                #     end
-                #
-                #     bank=BankAccount.find(1)
-                #     b.mark_as_super if bank.account_balance = 42 # a bit contrived, but you get the idea
-                #     b.save # oops, what's our balance now?
-                #
-                #  Now let's try it again with locked_fields
-                #
-                #     class BankAccount < Lanes::Model
-                #         attr_readonly :account_balance
-                #     end
-                #
-                #     bank=BankAccount.find(1)
-                #     b.mark_as_super if bank.account_balance = 42
-                #     b.save # Still not ideal since we marked the bank as super, but at least our balance is ok
-                #
-                #  To update the balance we'd need to:
-                #
-                #     b.unlock_fields( :account_balance ) do
-                #         b.account_balance += 33
-                #     end
-                #     b.save
-                #
-                #  This is still a bit contrived since we'd actually have
-                #  an audit logger that would be involved and it'd be inside a transaction.
-
-                def locked_fields( *flds )
-                    include InstanceMethods
-                    attr_readonly( *flds )
-                end
-
-                def has_locks( *locks )
-                    locks.each do | lock |
-                        define_method( "unlock_#{lock}" ) do | &block |
-                            instance_variable_set "@_lock_#{lock}_unlocked", true
-                            block.call
-                            remove_instance_variable "@_lock_#{lock}_unlocked"
-                        end
-                        define_method( "is_#{lock}_unlocked?") do
-                            instance_variable_defined? "@_lock_#{lock}_unlocked"
-                        end
-                    end
-                end
-
-            end
-
-            module InstanceMethods
-                # Unlock the field for updates inside the block
-                # yields, then restores it.
-                # Is class wide, meaning it Will temporarily open all instances of the class up for access in a threaded environment
-                def unlock_fields( *flds, &block )
-                    attr_syms = flds.map(&:to_s)
-
-                    self.class.attr_readonly.subtract( attr_syms )
-
-                    yield
-
-                    attr_syms.each do | fld |
-                        self.class.attr_readonly.add( fld )
-                    end
-
-                end
-            end
-
-        end
-    end
-end

data/lib/lanes/concerns/random_hash_code.rb

@@ -1,40 +0,0 @@
-module Lanes
-    module Concerns
-
-        # @see ClassMethods
-        module RandomHashCode
-
-            extend ActiveSupport::Concern
-
-            # ### Random Hash Code Concern
-            # This adds the {#has_random_hash_code} class method
-            module ClassMethods
-
-                # A random string that identifies an entity, such as a Customer, or Vendor
-                # The code is generated by {Lanes::Strings.random} for new records
-                # It's useful for generating *magic* links for access to an entity that cannot be guessed.
-                # @param field_name [Symbol] which field should the hash_code be stored in
-                # @param length [Integer] how long the hash_code should be
-
-                def has_random_hash_code( field_name: :hash_code, length: 12 )
-
-                    validates field_name, :presence=>{
-                        :message=>"hash code is not set (should be automatically chosen)"
-                    }
-
-                    scope :with_hash_code, lambda{ | code |
-                        where({ :hash_code=>code })
-                    }
-
-                    before_validation(:on=>:create) do
-                        self[ field_name ] = Lanes::Strings.random( length ) if self[ field_name ].blank?
-                    end
-
-                end
-            end
-
-        end
-
-    end
-
-end

data/lib/lanes/concerns/visible_id_identifier.rb

@@ -1,53 +0,0 @@
-module Lanes
-    module Concerns
-
-        # @see ClassMethods
-        module VisibleIdIdentifier
-
-            extend ActiveSupport::Concern
-
-            module InstanceMethods
-
-                # setup the visible id to the next available #{Lanes::SequentialId}
-                # @return [Integer] the assigned ID
-                def assign_visible_id!
-                    self.visible_id = Lanes::SequentialId.next_for( self.class )
-                end
-            end
-
-
-            # ### Visible ID Identifier Concern
-            # This adds the {#has_visible_id} class methods
-            module ClassMethods
-
-                # An auto-incrementing number that's user-visible.
-                # The visible_id is stored as an integer, but a string index is generated for
-                # querying by the sql like operator. The **with_visible_id** scope is available for this purpose
-                #
-                # The next number an also be adjusted by the end-user by setting {Lanes::SequentialId}
-                # so they can set the numbers to start at
-                # a specific point, which is useful for getting Invoice and other
-                # numbers to match up to a legacy system
-                def has_visible_id
-                    include InstanceMethods
-                    validates :visible_id, :presence=>{
-                                  :message=>"ID was not set (should be automatically chosen)"
-                              }
-                    alias_attribute :record_identifier, :visible_id
-                    before_validation :assign_visible_id!, :on=>:create
-
-                    export_scope :with_visible_id, lambda{ | visid |
-                        if visid.to_s =~/%/
-                            where( 'cast(visible_id as varchar) like ?', visid.to_s )
-                        else
-                            where( 'cast(visible_id as varchar) = ?',    visid.to_s )
-                        end
-                    }
-
-                end
-
-            end
-        end
-
-    end
-end

data/spec/concerns/code_identifier_spec.rb

@@ -1,45 +0,0 @@
-require "lanes/spec_helper"
-
-
-class CodeIdentifierTest < Lanes::TestCase
-
-    class CodeIdentifierTestModel
-        class_attribute :blocks
-        attr_accessor :code
-
-        include Lanes::Concerns::CodeIdentifier
-
-        def self.before_validation( opts={}, &block )
-            self.blocks||=[]
-            self.blocks.push( block )
-        end
-
-        def self.validates( *opts )
-        end
-
-        def run_validations
-            self.class.blocks.each{ |b| self.instance_eval(&b) }
-        end
-
-        def [](name)
-            :name == name ? 'A Long String of Nonsense' : ''
-        end
-
-        has_code_identifier :from => :name
-    end
-
-    def test_that_it_uppercases
-        ci = CodeIdentifierTestModel.new
-        ci.code='test'
-        ci.run_validations
-        assert_equal 'TEST', ci.code
-    end
-
-    def test_that_it_generates
-        ci = CodeIdentifierTestModel.new
-        ci.run_validations
-        assert ci.code.present?, "Code wasn't auto-generated"
-        assert_equal 'ALOSTOFNON',  ci.code
-    end
-
-end