tallty_duck_record 1.0.0

data/lib/duck_record/type/text.rb

@@ -0,0 +1,9 @@
+module DuckRecord
+  module Type
+    class Text < ActiveModel::Type::String # :nodoc:
+      def type
+        :text
+      end
+    end
+  end
+end

data/lib/duck_record/type/time.rb

@@ -0,0 +1,19 @@
+module DuckRecord
+  module Type
+    class Time < ActiveModel::Type::Time
+      include Internal::Timezone
+
+      class Value < DelegateClass(::Time) # :nodoc:
+      end
+
+      def serialize(value)
+        case value = super
+        when ::Time
+          Value.new(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/duck_record/type/unsigned_integer.rb

@@ -0,0 +1,15 @@
+module DuckRecord
+  module Type
+    class UnsignedInteger < ActiveModel::Type::Integer # :nodoc:
+      private
+
+        def max_value
+          super * 2
+        end
+
+        def min_value
+          0
+        end
+    end
+  end
+end

data/lib/duck_record/validations.rb

@@ -0,0 +1,67 @@
+require "duck_record/validations/uniqueness_on_real_record"
+require "duck_record/validations/subset"
+
+module DuckRecord
+  class RecordInvalid < DuckRecordError
+    attr_reader :record
+
+    def initialize(record = nil)
+      if record
+        @record = record
+        errors = @record.errors.full_messages.join(", ")
+        message = I18n.t(:"#{@record.class.i18n_scope}.errors.messages.record_invalid", errors: errors, default: :"errors.messages.record_invalid")
+      else
+        message = "Record invalid"
+      end
+
+      super(message)
+    end
+  end
+
+  # = Active Record \Validations
+  #
+  # Active Record includes the majority of its validations from ActiveModel::Validations
+  # all of which accept the <tt>:on</tt> argument to define the context where the
+  # validations are active. Active Record will always supply either the context of
+  # <tt>:create</tt> or <tt>:update</tt> dependent on whether the model is a
+  # {new_record?}[rdoc-ref:Persistence#new_record?].
+  module Validations
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+
+    # Runs all the validations within the specified context. Returns +true+ if
+    # no errors are found, +false+ otherwise.
+    #
+    # Aliased as #validate.
+    #
+    # If the argument is +false+ (default is +nil+), the context is set to <tt>:default</tt>.
+    #
+    # \Validations with no <tt>:on</tt> option will run no matter the context. \Validations with
+    # some <tt>:on</tt> option will only run in the specified context.
+    def valid?(context = nil)
+      context ||= default_validation_context
+      output = super(context)
+      errors.empty? && output
+    end
+
+    def valid!(context = nil)
+      if valid?(context)
+        true
+      else
+        raise RecordInvalid.new(self)
+      end
+    end
+
+    alias_method :validate, :valid?
+
+    private
+
+      def default_validation_context
+        :default
+      end
+
+      def perform_validations(options = {})
+        options[:validate] == false || valid?(options[:context])
+      end
+  end
+end

data/lib/duck_record/validations/subset.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module DuckRecord
+  module Validations
+    class SubsetValidator < ActiveModel::EachValidator # :nodoc:
+      ERROR_MESSAGE = "An object with the method #include? or a proc, lambda or symbol is required, " \
+                      "and must be supplied as the :in (or :within) option of the configuration hash"
+
+      def check_validity!
+        unless delimiter.respond_to?(:include?) || delimiter.respond_to?(:call) || delimiter.respond_to?(:to_sym)
+          raise ArgumentError, ERROR_MESSAGE
+        end
+      end
+
+      def validate_each(record, attribute, value)
+        unless subset?(record, value)
+          record.errors.add(attribute, :subset, options.except(:in, :within).merge!(value: value))
+        end
+      end
+
+      private
+
+      def delimiter
+        @delimiter ||= options[:in] || options[:within]
+      end
+
+      def subset?(record, value)
+        return false unless value.respond_to?(:to_a)
+
+        enumerable = value.to_a
+        members =
+          if delimiter.respond_to?(:call)
+            delimiter.call(record)
+          elsif delimiter.respond_to?(:to_sym)
+            record.send(delimiter)
+          else
+            delimiter
+          end
+
+        (members & enumerable).size == enumerable.size
+      end
+    end
+
+    module HelperMethods
+      # Validates whether the value of the specified attribute is available in a
+      # particular enumerable object.
+      #
+      #   class Person < ActiveRecord::Base
+      #     validates_inclusion_of :gender, in: %w( m f )
+      #     validates_inclusion_of :age, in: 0..99
+      #     validates_inclusion_of :format, in: %w( jpg gif png ), message: "extension %{value} is not included in the list"
+      #     validates_inclusion_of :states, in: ->(person) { STATES[person.country] }
+      #     validates_inclusion_of :karma, in: :available_karmas
+      #   end
+      #
+      # Configuration options:
+      # * <tt>:in</tt> - An enumerable object of available items. This can be
+      #   supplied as a proc, lambda or symbol which returns an enumerable. If the
+      #   enumerable is a numerical, time or datetime range the test is performed
+      #   with <tt>Range#cover?</tt>, otherwise with <tt>include?</tt>. When using
+      #   a proc or lambda the instance under validation is passed as an argument.
+      # * <tt>:within</tt> - A synonym(or alias) for <tt>:in</tt>
+      # * <tt>:message</tt> - Specifies a custom error message (default is: "is
+      #   not included in the list").
+      #
+      # There is also a list of default options supported by every validator:
+      # +:if+, +:unless+, +:on+, +:allow_nil+, +:allow_blank+, and +:strict+.
+      # See <tt>ActiveModel::Validations#validates</tt> for more information
+      def validates_subset_of(*attr_names)
+        validates_with SubsetValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/duck_record/validations/uniqueness_on_real_record.rb

@@ -0,0 +1,248 @@
+module DuckRecord
+  module Validations
+    class UniquenessOnRealRecordValidator < ActiveModel::EachValidator # :nodoc:
+      def initialize(options)
+        unless defined?(ActiveRecord)
+          raise NameError, "Not found Active Record."
+        end
+
+        if options[:conditions] && !options[:conditions].respond_to?(:call)
+          raise ArgumentError, "#{options[:conditions]} was passed as :conditions but is not callable. " \
+                               "Pass a callable instead: `conditions: -> { where(approved: true) }`"
+        end
+
+        @finder_class = if options[:class_name].present?
+                          options[:class_name].safe_constantize
+                        elsif options[:class].present? && options[:class].is_a?(Class)
+                          options[:class]
+                        else
+                          nil
+                        end
+
+        unless @finder_class
+          raise ArgumentError, "Must provide one of option :class_name or :class."
+        end
+        unless @finder_class < ActiveRecord::Base
+          raise ArgumentError, ":class must be an Active Record model, but got #{@finder_class}."
+        end
+        if @finder_class.abstract_class?
+          raise ArgumentError, ":class can't be an abstract class."
+        end
+
+        @primary_key = options[:primary_key]
+
+        super({ case_sensitive: true }.merge!(options))
+      end
+
+      def validate_each(record, attribute, value)
+        table = @finder_class.arel_table
+        value = map_enum_attribute(@finder_class, attribute, value)
+
+        relation = build_relation(@finder_class, table, attribute, value)
+        if @primary_key.present? && record.respond_to?(@primary_key)
+          if @finder_class.primary_key
+            relation = relation.where.not(@finder_class.primary_key => record.send(@primary_key))
+          else
+            raise ActiveRecord::UnknownPrimaryKey.new(@finder_class, "Can not validate uniqueness for persisted record without primary key.")
+          end
+        end
+        relation = scope_relation(record, table, relation)
+        relation = relation.merge(options[:conditions]) if options[:conditions]
+
+        if relation.exists?
+          error_options = options.except(:case_sensitive, :scope, :conditions)
+          error_options[:value] = value
+
+          record.errors.add(attribute, :taken, error_options)
+        end
+      end
+
+      protected
+
+        def build_relation(klass, table, attribute, value) #:nodoc:
+          if reflection = klass._reflect_on_association(attribute)
+            attribute = reflection.foreign_key
+            value = value.attributes[reflection.klass.primary_key] unless value.nil?
+          end
+
+          # the attribute may be an aliased attribute
+          if klass.attribute_alias?(attribute)
+            attribute = klass.attribute_alias(attribute)
+          end
+
+          attribute_name = attribute.to_s
+
+          column = klass.columns_hash[attribute_name]
+          cast_type = klass.type_for_attribute(attribute_name)
+          value = cast_type.serialize(value)
+          value = klass.connection.type_cast(value)
+
+          comparison = if !options[:case_sensitive] && !value.nil?
+            # will use SQL LOWER function before comparison, unless it detects a case insensitive collation
+            klass.connection.case_insensitive_comparison(table, attribute, column, value)
+          else
+            klass.connection.case_sensitive_comparison(table, attribute, column, value)
+          end
+          if value.nil?
+            klass.unscoped.where(comparison)
+          else
+            bind = ActiveRecord::Relation::QueryAttribute.new(attribute_name, value, ActiveRecord::Type::Value.new)
+            klass.unscoped.where(comparison, bind)
+          end
+        rescue RangeError
+          klass.none
+        end
+
+        def scope_relation(record, table, relation)
+          Array(options[:scope]).each do |scope_item|
+            scope_value = if record.class._reflect_on_association(scope_item)
+              record.association(scope_item).reader
+            else
+              record._read_attribute(scope_item)
+            end
+            relation = relation.where(scope_item => scope_value)
+          end
+
+          relation
+        end
+
+        def map_enum_attribute(klass, attribute, value)
+          mapping = klass.defined_enums[attribute.to_s]
+          value = mapping[value] if value && mapping
+          value
+        end
+    end
+
+    module ClassMethods
+      # Validates whether the value of the specified attributes are unique
+      # across the system. Useful for making sure that only one user
+      # can be named "davidhh".
+      #
+      #   class Person < ActiveRecord::Base
+      #     validates_uniqueness_of :user_name
+      #   end
+      #
+      # It can also validate whether the value of the specified attributes are
+      # unique based on a <tt>:scope</tt> parameter:
+      #
+      #   class Person < ActiveRecord::Base
+      #     validates_uniqueness_of :user_name, scope: :account_id
+      #   end
+      #
+      # Or even multiple scope parameters. For example, making sure that a
+      # teacher can only be on the schedule once per semester for a particular
+      # class.
+      #
+      #   class TeacherSchedule < ActiveRecord::Base
+      #     validates_uniqueness_of :teacher_id, scope: [:semester_id, :class_id]
+      #   end
+      #
+      # It is also possible to limit the uniqueness constraint to a set of
+      # records matching certain conditions. In this example archived articles
+      # are not being taken into consideration when validating uniqueness
+      # of the title attribute:
+      #
+      #   class Article < ActiveRecord::Base
+      #     validates_uniqueness_of :title, conditions: -> { where.not(status: 'archived') }
+      #   end
+      #
+      # When the record is created, a check is performed to make sure that no
+      # record exists in the database with the given value for the specified
+      # attribute (that maps to a column). When the record is updated,
+      # the same check is made but disregarding the record itself.
+      #
+      # Configuration options:
+      #
+      # * <tt>:message</tt> - Specifies a custom error message (default is:
+      #   "has already been taken").
+      # * <tt>:scope</tt> - One or more columns by which to limit the scope of
+      #   the uniqueness constraint.
+      # * <tt>:conditions</tt> - Specify the conditions to be included as a
+      #   <tt>WHERE</tt> SQL fragment to limit the uniqueness constraint lookup
+      #   (e.g. <tt>conditions: -> { where(status: 'active') }</tt>).
+      # * <tt>:case_sensitive</tt> - Looks for an exact match. Ignored by
+      #   non-text columns (+true+ by default).
+      # * <tt>:allow_nil</tt> - If set to +true+, skips this validation if the
+      #   attribute is +nil+ (default is +false+).
+      # * <tt>:allow_blank</tt> - If set to +true+, skips this validation if the
+      #   attribute is blank (default is +false+).
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
+      #   if the validation should occur (e.g. <tt>if: :allow_validation</tt>,
+      #   or <tt>if: Proc.new { |user| user.signup_step > 2 }</tt>). The method,
+      #   proc or string should return or evaluate to a +true+ or +false+ value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to
+      #   determine if the validation should not occur (e.g. <tt>unless: :skip_validation</tt>,
+      #   or <tt>unless: Proc.new { |user| user.signup_step <= 2 }</tt>). The
+      #   method, proc or string should return or evaluate to a +true+ or +false+
+      #   value.
+      #
+      # === Concurrency and integrity
+      #
+      # Using this validation method in conjunction with
+      # {ActiveRecord::Base#save}[rdoc-ref:Persistence#save]
+      # does not guarantee the absence of duplicate record insertions, because
+      # uniqueness checks on the application level are inherently prone to race
+      # conditions. For example, suppose that two users try to post a Comment at
+      # the same time, and a Comment's title must be unique. At the database-level,
+      # the actions performed by these users could be interleaved in the following manner:
+      #
+      #               User 1                 |               User 2
+      #  ------------------------------------+--------------------------------------
+      #  # User 1 checks whether there's     |
+      #  # already a comment with the title  |
+      #  # 'My Post'. This is not the case.  |
+      #  SELECT * FROM comments              |
+      #  WHERE title = 'My Post'             |
+      #                                      |
+      #                                      | # User 2 does the same thing and also
+      #                                      | # infers that their title is unique.
+      #                                      | SELECT * FROM comments
+      #                                      | WHERE title = 'My Post'
+      #                                      |
+      #  # User 1 inserts their comment.     |
+      #  INSERT INTO comments                |
+      #  (title, content) VALUES             |
+      #  ('My Post', 'hi!')                  |
+      #                                      |
+      #                                      | # User 2 does the same thing.
+      #                                      | INSERT INTO comments
+      #                                      | (title, content) VALUES
+      #                                      | ('My Post', 'hello!')
+      #                                      |
+      #                                      | # ^^^^^^
+      #                                      | # Boom! We now have a duplicate
+      #                                      | # title!
+      #
+      # This could even happen if you use transactions with the 'serializable'
+      # isolation level. The best way to work around this problem is to add a unique
+      # index to the database table using
+      # {connection.add_index}[rdoc-ref:ConnectionAdapters::SchemaStatements#add_index].
+      # In the rare case that a race condition occurs, the database will guarantee
+      # the field's uniqueness.
+      #
+      # When the database catches such a duplicate insertion,
+      # {ActiveRecord::Base#save}[rdoc-ref:Persistence#save] will raise an ActiveRecord::StatementInvalid
+      # exception. You can either choose to let this error propagate (which
+      # will result in the default Rails exception page being shown), or you
+      # can catch it and restart the transaction (e.g. by telling the user
+      # that the title already exists, and asking them to re-enter the title).
+      # This technique is also known as
+      # {optimistic concurrency control}[http://en.wikipedia.org/wiki/Optimistic_concurrency_control].
+      #
+      # The bundled ActiveRecord::ConnectionAdapters distinguish unique index
+      # constraint errors from other types of database errors by throwing an
+      # ActiveRecord::RecordNotUnique exception. For other adapters you will
+      # have to parse the (database-specific) exception message to detect such
+      # a case.
+      #
+      # The following bundled adapters throw the ActiveRecord::RecordNotUnique exception:
+      #
+      # * ActiveRecord::ConnectionAdapters::Mysql2Adapter.
+      # * ActiveRecord::ConnectionAdapters::SQLite3Adapter.
+      # * ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.
+      def validates_uniqueness_on_real_record_of(*attr_names)
+        validates_with UniquenessOnRealRecordValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/duck_record/version.rb

@@ -0,0 +1,3 @@
+module DuckRecord
+  VERSION = "1.0.0"
+end

data/lib/tasks/acts_as_record_tasks.rake

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