ice_t 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e836e34bd0669110cda706f4a8d0d378768fcabb
-  data.tar.gz: 8e95eb9dab2a959d6ad93f31bc749a28e0586633
+  metadata.gz: 4f45183041524f2add8f09a2a163212717bd35ca
+  data.tar.gz: a4aff30ce9adff183d1b5542e97cb6779fa46d99
 SHA512:
-  metadata.gz: fe6cfe556bd2a5f8361fd9ebcc288c3a4a5984e19647f754ec590999a08ea666c3a0570b59b992e054d1575d823cd653db4aff55caec1cc6776939941f695a06
-  data.tar.gz: baa10bc4ffb1269360a6ffddfc1f2642300badb8b17ff1ebaecbd60b85f4cf5cb75a0cad9a8111c9ec5da5461ff09e1f195fd013dcd46ce2ce3cbe883fd95c18
+  metadata.gz: e7a0453d29ab8baadd22ab916b3306c8da871d27d26aee24ec4ee8a8f7db496400f5a12f1433e6aac8e54b7da237df37f41499af71c1a0a2d26568970089fb27
+  data.tar.gz: ca7784d2b5274e61409d60dda498071889631629c92babada557d4d13f5b4e3703f3504cad534ef5a35f71d6311db01b7cf09dbe5861389270f08c83e94485b9

data/README.md

@@ -1,9 +1,11 @@
 # IceT
 
+[![Gem Version](https://badge.fury.io/rb/ice_t.png)](http://badge.fury.io/rb/ice_t)
 [![Code Climate](https://codeclimate.com/github/XORwell/ice_t.png)](https://codeclimate.com/github/XORwell/ice_t)
 [![Build Status](https://travis-ci.org/XORwell/ice_t.png)](https://travis-ci.org/XORwell/ice_t)
+[![Dependency Status](https://gemnasium.com/XORwell/ice_t.png)](https://gemnasium.com/XORwell/ice_t)
 
-TODO: Write a gem description
+IceT is a ruby library for handling repeated events.
 
 ## Installation
 
@@ -21,17 +23,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating rules
 
+```ruby
+rule = IceT::Rule::Secondly.new(42)  # => step by 42 seconds
+rule = IceT::Rule::Minutely.new(42)  # => step by 42 minutes
+rule = IceT::Rule::Hourly.new(42)    # => step by 42 hours
+rule = IceT::Rule::Daily.new(42)     # => step by 42 days
+rule = IceT::Rule::Weekly.new(42)    # => step by 42 weeks
+rule = IceT::Rule::Monthly.new(42)   # => step by 42 months
+rule = IceT::Rule::Yearly.new(42)    # => step by 42 years
+```
 
-## Tipps
+### Get time occurrences
 
-	### Sorting rules:
+```ruby
+rule.occurrences # => Array of times
+```
 
-	[r2,r1,r3].sort.collect(&:interval) 
+### Schedule
+The Schedule helps on dealing with multiple rules.
 
-	### Comparing comparing:
+```ruby
+schedule = IceT::Schedule.new(start_time: Time.now, end_time: Time.now + 4.months)
+schedule.add_rule my_daily_rule
+schedule.add_rule my_monthly_rule
 
-	daily(1) < daily(2)
+schedule.rules              # => Array of rules
+schedule.occurrences        # => Merged occurrences
+```
 
+### Persistence
+
+Lets say you want to your Schedule in your database
+and use it later again. You can do this:
+
+```ruby
+json = schedule.to_json
+schedule = IceT::Schedule.from_json(json)
+```
+
+## Tipps - doc in development
+
+### Sorting rules:
+
+[r2,r1,r3].sort.collect(&:interval) 
+
+### Comparing rules:
+	
+```ruby
+IceT::Rule::Daily.new(1) < IceT::Rule::Monthly.new(1) # => true
+```
 	r2.between?(r1, r3)

data/lib/ice_t/rule/weekly.rb

@@ -0,0 +1,10 @@
+module IceT
+  module Rule
+    class Weekly < Base
+      class << self
+        def to_i; 1.week.to_i end  
+        def unit; :weeks end      
+      end      
+    end
+  end
+end

data/lib/ice_t/rule.rb

@@ -9,6 +9,7 @@ require 'ice_t/rule/secondly'
 require 'ice_t/rule/minutely'
 require 'ice_t/rule/hourly'
 require 'ice_t/rule/daily'
+require 'ice_t/rule/weekly'
 require 'ice_t/rule/monthly'
 require 'ice_t/rule/yearly'
 

data/lib/ice_t/version.rb

@@ -1,3 +1,3 @@
 module IceT
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/rules/weekly_rule_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe IceT::Rule::Weekly do
+  let(:klass) { IceT::Rule::Weekly }
+  it_behaves_like "a rule"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ice_t
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Christian Nennemann
@@ -136,6 +136,7 @@ files:
 - lib/ice_t/rule/monthly.rb
 - lib/ice_t/rule/repository.rb
 - lib/ice_t/rule/secondly.rb
+- lib/ice_t/rule/weekly.rb
 - lib/ice_t/rule/yearly.rb
 - lib/ice_t/schedule.rb
 - lib/ice_t/time_helper.rb
@@ -149,6 +150,7 @@ files:
 - spec/rules/monthly_rule_spec.rb
 - spec/rules/rules_repository_spec.rb
 - spec/rules/secondly_rule_spec.rb
+- spec/rules/weekly_rule_spec.rb
 - spec/rules/yearly_rule_spec.rb
 - spec/schedule_spec.rb
 - spec/spec_helper.rb
@@ -186,6 +188,7 @@ test_files:
 - spec/rules/monthly_rule_spec.rb
 - spec/rules/rules_repository_spec.rb
 - spec/rules/secondly_rule_spec.rb
+- spec/rules/weekly_rule_spec.rb
 - spec/rules/yearly_rule_spec.rb
 - spec/schedule_spec.rb
 - spec/spec_helper.rb