acts_as_span 0.0.5 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ed7f152ad93220467d76ca831763a2a4dbd02ba
+  data.tar.gz: eaf693675a0aa764b8d85a77464b9897787993be
+SHA512:
+  metadata.gz: 686a48328384d0e29b0aba18af0d957cc06d0e8ab4fd051d72a33a8515c23115eca337427424f0e920edbf5970abb3605d12b582fa9df37799a0ed911624d8de
+  data.tar.gz: a35877b8ff3c5748a921fb095dd925791e1212246dc0442835a5e3e5c77cbdc30ec659a69d56cc55fbc0e4eee154f53babf7a70a26ee194674a9ad59e4cb0cdb

data/.gitignore

@@ -1,3 +1,11 @@
-coverage
-rdoc
-pkg
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.DS_Store
+*.log
+*.sqlite
+
+.rvmrc
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.8
+  - 2.3.5
+notifications:
+  email: false

data/Gemfile

@@ -2,6 +2,3 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in acts_as_span.gemspec
 gemspec
-
-gem 'rspec'
-gem 'acts_as_fu'

data/README.rdoc

@@ -1,6 +1,8 @@
 = acts_as_span
 
-ActiveRecord model w/ a start_date and an end_date
+ActiveRecord model w/ a start_date and an end_date == ActsAsSpan
+
+Treat those date spans like the objects they are!
 
 == Getting Started
 
@@ -14,20 +16,6 @@ In your model:
       acts_as_span
     end
 
-In your migrations:
-
-    class AddSpanToSpanRecord < ActiveRecord::Migration
-      def self.up
-        add_column :span_records, :start_date, :date
-        add_column :span_records, :end_date, :date
-      end
-
-      def self.down
-        remove_column :span_records, :start_date
-        remove_column :span_records, :end_date
-      end
-    end
-
 == Copyright
 
-Copyright (c) 2011 Annkissam. See LICENSE for details.
+Copyright (c) 2011-2018 Annkissam. See LICENSE for details.

data/Rakefile

@@ -1,4 +1,8 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+
+#RSPEC
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/acts_as_span.gemspec

@@ -9,15 +9,31 @@ Gem::Specification.new do |s|
   s.email       = ["eric.sullivan@annkissam.com"]
   s.homepage    = "https://github.com/annkissam/acts_as_span"
   s.summary     = ActsAsSpan::VERSION::SUMMARY
-  s.description = %q{start_date and end_date as a span w/ ActiveRecord}
+  s.description = %q{ActiveRecord model w/ a start_date and an end_date == ActsAsSpan}
+  s.license       = "MIT"
 
-  s.rubyforge_project = "acts_as_span"
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if s.respond_to?(:metadata)
+    s.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+          "public gem pushes."
+  end
 
   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_dependency(%q<activerecord>, [">= 3"])
-  s.add_dependency('activesupport')
+
+  s.add_development_dependency "bundler", "~> 1.15"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "has_siblings", "~> 0.2.7"
+  s.add_development_dependency "temping"
+  s.add_development_dependency "pry-byebug"
+
+  s.add_runtime_dependency('activerecord', '>= 4.2.0')
+  s.add_runtime_dependency('activesupport', '>= 4.2.0')
 end

data/lib/acts_as_span.rb

@@ -1,161 +1,118 @@
-require 'active_support'
 require 'ostruct'
-require 'forwardable'
+require 'acts_as_span/version'
+require 'acts_as_span/span_klass'
+require 'acts_as_span/span_instance'
+
+require 'acts_as_span/no_overlap_validator'
+require 'acts_as_span/within_parent_date_span_validator'
 
-ACTS_AS_SPAN_PATH = File.dirname(__FILE__) + "/acts_as_span/"
 
-require ACTS_AS_SPAN_PATH + 'version'
-require ACTS_AS_SPAN_PATH + 'span_klass'
-require ACTS_AS_SPAN_PATH + 'span_instance'
+require 'active_support'
+require 'active_record'
 
 module ActsAsSpan
   extend ActiveSupport::Concern
-  
+
   class << self
     def options
       @options ||= {
-        :start_date_field => :start_date,
-        :end_date_field => :end_date,
-        :start_date_field_required => false,
-        :end_date_field_required => false,
-        :span_overlap_scope => nil,
-        :span_overlap_count => nil,
+        :start_field => :start_date,
+        :end_field => :end_date,
         :name => :default
       }
     end
-    
+
     def configure
       yield(self) if block_given?
     end
   end
-  
-  #by default, all model classess & their instances will return false w/ acts_as_span?
-  included do
-    self.send(:extend, ActsAsSpan::NegativeMethods)
-    self.send(:include, ActsAsSpan::NegativeMethods)
-  end
-  
+
   module ClassMethods
     def acts_as_span(*args)
-      #this model & its instances will return true w/ acts_as_span?
-      self.send(:extend, ActsAsSpan::PositiveMethods)
-      self.send(:include, ActsAsSpan::PositiveMethods)
-      
-      self.send(:extend, Forwardable)
-      
       self.send(:extend, ActsAsSpan::ExtendedClassMethods)
       self.send(:include, ActsAsSpan::IncludedInstanceMethods)
-      
+
       options = OpenStruct.new(args.last.is_a?(Hash) ? ActsAsSpan.options.merge(args.pop) : ActsAsSpan.options)
-      
-      #if span_overlap_scope is specified the span_overlap_count defaults to 0
-      options.span_overlap_count ||= 0 if options.span_overlap_scope
-      
+
       acts_as_span_definitions[options.name] = options
-      
-      def_delegators :span, :close!,
-                            :close_on!,
-                            :span_status,
-                            :span_status_on,
-                            :span_status_to_s,
-                            :span_status_to_s_on,
-                            :current?,
-                            :current_on?,
-                            :future?,
-                            :future_on?,
-                            :expired?,
-                            :expired_on?
-                            
-      def_delegators 'self.class', :acts_as_span_definitions
-      
+
+      # TODO add tests that check delegation of all methos in span
+      delegate :span_status,
+               :span_status_on,
+               :current?,
+               :current_on?,
+               :future?,
+               :future_on?,
+               :expired?,
+               :expired_on?,
+               :past?,
+               :past_on?, to: :span
+
+      delegate :acts_as_span_definitions, to: :class
+
+      # TODO idem above
       class << self
-        self.send(:extend, Forwardable)
-        
-        def_delegators :span, :current,
-                              :current_on,
-                              :future,
-                              :future_on,
-                              :expired,
-                              :expired_on
+        delegate :current,
+                 :current_on,
+                 :future,
+                 :future_on,
+                 :expired,
+                 :expired_on,
+                 :past_on,
+                 :past,
+                 :current_or_future_on,
+                 :current_or_future, to: :span
       end
-      
+
       validate :validate_spans
     end
-    
+
     def acts_as_span_definitions
       @_acts_as_span_definitions ||= {}
     end
   end
-  
+
   module ExtendedClassMethods
-    def overlap(test_record)
-      overlap_for(test_record, :default, :default)
-    end
-    
-    def overlap_for(test_record, test_record_span_name = :default, this_span_name = :default)
-      span_for(this_span_name).overlap(test_record.span_for(test_record_span_name))
-    end
-    
     def spans
       acts_as_span_definitions.keys.map { |acts_as_span_definition_name| span_for(acts_as_span_definition_name) }
     end
-    
+
     def span
       span_for(:default)
     end
-    
+
     def span_for(name = :default)
       acts_as_span_klasses[name] ||= SpanKlass.new(name, self, acts_as_span_definitions[name])
     end
-    
+
     def acts_as_span_klasses
       @_acts_as_span_klasses ||= {}
     end
   end
-  
+
   module IncludedInstanceMethods
     def spans
       acts_as_span_definitions.keys.map { |acts_as_span_definition_name| span_for(acts_as_span_definition_name) }
     end
-    
+
     def span
       span_for(:default)
     end
-    
+
     def span_for(name = :default)
       acts_as_span_instances[name] ||= SpanInstance.new(name, self, acts_as_span_definitions[name])
     end
-    
+
     def acts_as_span_instances
       @_acts_as_span_instances ||= {}
     end
-    
+
     def validate_spans
       spans.each(&:validate)
     end
-    
-    #This syntax assumes :default span
-    def overlap?(other_record)
-      overlap_for?(other_record, :default, :default)
-    end
-    
-    #record.span_for(:this_span_name).overlap?(other_record.span_for(:other_record_span_name))
-    def overlap_for?(other_record, this_span_name = :default, other_record_span_name = :default)
-      span_for(this_span_name).overlap?(other_record.span_for(other_record_span_name))
-    end
-  end
-  
-  module PositiveMethods
-    send(:define_method, "acts_as_span?") do
-      true
-    end
-  end
-  
-  module NegativeMethods
-    send(:define_method, "acts_as_span?") do
-      false
-    end
   end
 end
 
-ActiveRecord::Base.send(:include, ActsAsSpan)
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.send(:include, ActsAsSpan)
+end

data/lib/acts_as_span/no_overlap_validator.rb

@@ -0,0 +1,51 @@
+require 'active_model'
+
+module ActsAsSpan
+  class NoOverlapValidator < ActiveModel::Validator
+    def validate(record)
+      overlapping_records = temporally_overlapping_for(record)
+      instance_scope = options[:instance_scope].is_a?(Proc) ? record.instance_eval(&options[:instance_scope]) : true
+
+      if overlapping_records.any? && instance_scope
+
+        error_type = overlapping_records.size == 1 ? "no_overlap.one" : "no_overlap.other"
+
+        record.errors.add(
+          :base,
+          error_type.to_sym,
+          model_name: record.class.model_name.human,
+          model_name_plural: record.class.model_name.plural.humanize,
+          start_date: record.start_date,
+          end_date: record.end_date,
+          count: overlapping_records.size,
+          overlapping_records_s: overlapping_records.join(",")
+        )
+      end
+    end
+
+    #TODO add back condition for start_date nil
+    #TODO add configuration for span configuration
+    def temporally_overlapping_for(record)
+      scope = record.instance_eval(&options[:scope])
+
+      start_date = record.start_date || Date.current
+      end_date = record.end_date
+      arel_table = record.class.arel_table
+
+      if end_date
+        scope.where(
+          arel_table[:start_date].lteq(end_date).
+          and(
+            arel_table[:end_date].gteq(start_date).
+            or(arel_table[:end_date].eq(nil))
+          )
+        )
+      else
+        scope.where(
+          arel_table[:end_date].gteq(start_date).
+          or(arel_table[:end_date].eq(nil))
+        )
+      end
+    end
+  end
+end

data/lib/acts_as_span/span_instance.rb

@@ -1,53 +1,37 @@
-require 'forwardable'
+require 'acts_as_span/span_instance/validations'
+require 'acts_as_span/span_instance/status'
 
-require ACTS_AS_SPAN_PATH + 'span_instance/validations'
-require ACTS_AS_SPAN_PATH + 'span_instance/status'
-require ACTS_AS_SPAN_PATH + 'span_instance/overlap'
+require 'active_support/core_ext/module/delegation'
 
 module ActsAsSpan
   class SpanInstance
-    extend Forwardable
-    
     include ActsAsSpan::SpanInstance::Validations
     include ActsAsSpan::SpanInstance::Status
-    include ActsAsSpan::SpanInstance::Overlap
-    
-    def_delegators :@acts_as_span_definition, :start_date_field,
-                                              :end_date_field,
-                                              :start_date_field_required,
-                                              :end_date_field_required,
-                                              :exclude_end,
-                                              :span_overlap_scope,
-                                              :span_overlap_count
-                                              
-    def_delegators :span_model, :new_record?
-    
+
+    delegate :start_field,
+             :end_field,
+             :exclude_end, to: :@acts_as_span_definition
+
+    delegate :new_record?, to: :span_model
+
     attr_reader :name, :span_model, :acts_as_span_definition
-    
+
     def initialize(name, span_model, acts_as_span_definition)
       @name = name
       @span_model = span_model
       @acts_as_span_definition = acts_as_span_definition
     end
-    
+
     def span_klass
       @span_klass ||= span_model.class
     end
-    
+
     def start_date
-      span_model[start_date_field]
+      span_model[start_field]
     end
-    
+
     def end_date
-      span_model[end_date_field]
-    end
-    
-    def close!(close_date = Date.today)
-      if end_date.blank?
-        span_model.update_attributes!(end_date_field => close_date)
-      end
+      span_model[end_field]
     end
-    
-    alias_method :close_on!, :close!
   end
-end
+end