dates_resolver 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 949a2ae46104af1346560fa4546127f71be41a0c
-  data.tar.gz: 529526332d42f289299eb9fcd208e1c8a6ade012
+  metadata.gz: 181677f30beec36650f45242c8444ccb7704153d
+  data.tar.gz: c7c3fa28bf7013e8748d06b2a071d61c4c050cc8
 SHA512:
-  metadata.gz: 142ec1a11365c5130d61c635956397c2b40af0fd339fb020d301219b33ebc074410c3e1b9ef2c59fab0e8a3db1debd822fe2139bc13ea6c68291e7851d9fbf34
-  data.tar.gz: 9ddaa8f323d56afdcf9aa3546ba4ab02d965fa3344c5db052de8423eb079ffa4f8d483aba876794e35da5efdd9618d2b9bc5524a2970aa569f8322437767972d
+  metadata.gz: 454b18a13f0e6ddf7d3c91584681a73bc658211000412c1a09be7acdf155fff224fe8e2d43e84b69797635d1bb7a9561b303cf815ceeb3a625c51078f260ec5b
+  data.tar.gz: 877271e3c640448f184491ea494eb9ef0a4872be8a7abf17330ab587f22bc3ccaa56bdbe28a702e05ed95545be99e1734a276acaf1459dd434918e06d5047e76

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sathshh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dates_resolver.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    dates_resolver (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  dates_resolver!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sathish
+
+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,53 @@
+# DatesResolver
+As the name suggests it splits overlapping date ranges in a neat object oriented way.
+
+# How it does this
+It consumes a collection of ruby objects of which each respond to :start_date and :end_date that are overlapping.
+Normalizes them and splits them based on the overlaps.. returning again a collection of modified and cloned objects of the same type.
+
+
+
+![Logic](https://raw.githubusercontent.com/SathishAchilles/DatesResolver/master/images/dates_resolver_logic.PNG?_sm_au_=iqM0KTfNWWQrH4kM)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dates_resolver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dates_resolver
+
+## Usage
+
+Dates resolver marks the dates ranges by looking at the `:start_date` and `:end_date` attributes of each object.
+So it is mandatory that the objects respond to these methods.
+
+```ruby
+require 'dates_resolver'
+```
+
+```ruby
+DatesResolver::AR.new(date_range_overlapping_ar_objects).resolve
+```
+
+One of the simple usecases would be in Insurance sector, where users are prone to have multiple insurance policies with overlapping maturity periods. We could resolve the overlapping maturity periods of multiple insurance policies owned by the user and calculating the total premium amount for the user during that overlapping period.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dates_resolver. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DatesResolver project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dates_resolver/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dates_resolver"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dates_resolver.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dates_resolver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dates_resolver"
+  spec.version       = DatesResolver::VERSION
+  spec.authors       = ["Sathish"]
+  spec.email         = ["sathshh@gmail.com"]
+
+  spec.summary       = %q{Splits overlapping date ranges in a neat object oriented way}
+  spec.description   = %q{It consumes a collection of objects with Date ranges that are overlapping and Normalizes or splits them based on the overlaps.. returns the splitted dates as same type of objects again}
+  spec.homepage      = "https://rubygems.org/gems/dates_resolver"
+  spec.license       = "MIT"
+
+  # 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 spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/gems/dates_resolver"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/dates_resolver.rb

@@ -1,7 +1,9 @@
+require "dates_resolver/version"
 require 'logger'
 # accepts Collection of ActiveRecord Objects with attributes start date and end date
 # returns a collection of ActiveRecord Objects with resolved date ranges
-class DatesResolver
+module DatesResolver
+  class AR
   def initialize(collection_of_objects=[])
     @collection = collection_of_objects
     @start_dates = @collection.map(&:start_date).uniq
@@ -12,7 +14,6 @@ class DatesResolver
   end
 
   def resolve
-
     @collection.each do |obj|
       new_obj = obj.clone
       @dates.each_with_index do |date, i|
@@ -28,34 +29,35 @@ class DatesResolver
         #hack for 1day overlaps
         #TODO: patch it
         if (@end_dates.include?(date) && @start_dates.include?(date))
-            start_date = date
-            end_date = date
-            next_date = date
-            increment_next_date(next_date)
+          start_date = date
+          end_date = date
+          next_date = date
+          increment_next_date(next_date)
         else
-            # start date is set to be the date value in current iteration
-            start_date = date
-            next_date = @dates[i+1]
-            end_date = (if @start_dates.include?(next_date)
-              (next_date -1)
-            else
-              #seems the next coming up date is an end_date
-              increment_next_date(next_date)
-              next_date
-            end)
-         end
-
-        new_obj.start_date = start_date
-        new_obj.end_date = end_date
-        @new_collection << new_obj.clone
-        #resolve only 1 overlapping promotional end or exception at once.
-        #also halt the resolver if the max end date is achieved
-        break if (end_date == obj.end_date || end_date == @dates.last)
+          # start date is set to be the date value in current iteration
+          start_date = date
+          next_date = @dates[i+1]
+          end_date = (if @start_dates.include?(next_date)
+          (next_date -1)
+        else
+          #seems the next coming up date is an end_date
+          increment_next_date(next_date)
+          next_date
+        end)
       end
+
+      new_obj.start_date = start_date
+      new_obj.end_date = end_date
+      @new_collection << new_obj.clone
+      #resolve only 1 overlapping promotional end or exception at once.
+      #also halt the resolver if the max end date is achieved
+      break if (end_date == obj.end_date || end_date == @dates.last)
     end
-    @new_collection.uniq
+  end
+  @new_collection.uniq
   end
 
+  private
   def add_and_sort_dates_collection(new_date,dates)
     dates << new_date
     dates.sort!.uniq!
@@ -77,3 +79,4 @@ class DatesResolver
     end
   end
 end
+end

data/lib/dates_resolver/version.rb

@@ -0,0 +1,3 @@
+module DatesResolver
+  VERSION = "0.1.0"
+end

metadata

@@ -1,27 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: dates_resolver
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- SathishAchilles
+- Sathish
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
-dependencies: []
-description: It consumes two ActiveRecords Date ranges that are overlapping and splits
-  them based on the overlaps.. returns the splits as ActiveRecords again
-email: sathshh@gmail.com
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: It consumes a collection of objects with Date ranges that are overlapping
+  and Normalizes or splits them based on the overlaps.. returns the splitted dates
+  as same type of objects again
+email:
+- sathshh@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dates_resolver.gemspec
+- images/dates_resolver_logic.PNG
 - lib/dates_resolver.rb
-homepage: http://rubygems.org/gems/dates_resolver
+- lib/dates_resolver/version.rb
+homepage: https://rubygems.org/gems/dates_resolver
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org/gems/dates_resolver
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -38,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: A simple gem to resolve the overlapping date ranges..
+summary: Splits overlapping date ranges in a neat object oriented way
 test_files: []