schedule-dsl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b47e80c9c20de3922c89fec31755c1306f5d5b008f760eea5b67e3637d7e978
+  data.tar.gz: 802e2a55333f9a058951d6e15e679eeeb7092286525698a2fcff66efebf52780
+SHA512:
+  metadata.gz: adbc130c9ec66a7f5aa213a9f36e70f23a74f1e21681b3b91066fb9ae0e33fb6d48e7ee0582606c64886ce8d9ff0d6de3852f3ea5372a6538424b62f7d191163
+  data.tar.gz: 8f6b8a1f188bce244fb536aae111163614d02ebe3d277b814eb5af6fe9adb5b9882e38ebcb3b9087db9a18eb78ff639de1f6fd751456f53a9b32fd3694f47ebc

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+group(:spec) do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,68 @@
+# About
+
+_Provides a DSL for defining your schedule rules and getting results for given date._
+
+# Examples
+
+## Collect returned values
+
+```ruby
+# Your definition file.
+
+rule Proc.new { true } do
+  "Go swimming"
+end
+
+rule Proc.new { false } do
+  "Steal things from little kids"
+end
+
+rule -> (date) { date.tuesday? } do
+  "Read a book"
+end
+```
+
+```ruby
+# Your script.
+
+require 'schedule'
+
+table = Schedule.load(definition_file_path)
+table.filter(Date.today).evaluate
+# => ["Go swimming", "Read a book"]
+```
+
+## Use a collector object
+
+```ruby
+# Your definition file.
+
+rule -> (date) { date.tuesday? } do |time_frames|
+  time_frames[:morning] << "Go swimming"
+end
+
+rule -> (date) { date.weekday? } do |time_frames|
+  time_frames[:evening] << "Read a book"
+end
+```
+
+```ruby
+# Your script.
+
+require 'schedule'
+
+table = Schedule.load(definition_file_path)
+time_frames = {morning: Array.new}
+table.filter(Date.today).evaluate(time_frames) # Ignore the result.
+time_frames # => {morning: "Go swimming"}
+```
+
+# API
+
+## Custom `Date` extensions
+
+Date passed as an argument to the condition is extended with `Schedule::DateExts`.
+
+- `Date#weekend?`
+- `Date#weekday?`
+- `Date#last_day_of_a_month?`

data/lib/schedule.rb

@@ -0,0 +1,98 @@
+require 'date'
+require 'forwardable'
+
+module Schedule
+  # Load schedule from definition file.
+  def self.load(path)
+    context = DSL.new
+    context.instance_eval(File.read(path), path)
+    context.rules
+  end
+
+  class RuleList
+    extend Forwardable
+
+    attr_reader :rules
+    def initialize
+      @rules = Array.new
+    end
+
+    def_delegators :rules, :length, :first, :empty?, :<<
+
+    def filter(date)
+      FilteredRuleList.new(
+        date.extend(DateExts),
+        self.rules.select { |rule| rule.condition.call(date) })
+    end
+  end
+
+  class FilteredRuleList
+    extend Forwardable
+
+    attr_reader :date, :rules
+    def initialize(date, rules)
+      @date, @rules = date, rules
+    end
+
+    def_delegators :rules, :length, :first, :empty?, :<<
+
+    # This method can be used in one of two ways:
+    #
+    # Either directly collect the results or pass a collection object,
+    # fill it in and then use that object directly rather than using
+    # the output of this method.
+    #
+    # # Collecting the results directly
+    #
+    #   rule -> (date) { date.tuesday? } do
+    #     "Go swimming"
+    #   end
+    #
+    #   list.evaluate # => ["Go swimming"]
+    #
+    # # Using a collection object
+    #
+    #   rule -> (date) { date.tuesday? } do |time_frames|
+    #     time_frames[:morning] << "Go swimming"
+    #   end
+    #
+    #   time_frames = {morning: Array.new}
+    #   list.evaluate(time_frames) # Ignore the result.
+    #   time_frames # => {morning: "Go swimming"}
+    def evaluate(*args)
+      self.rules.map { |rule| rule.block.call(*args) }
+    end
+  end
+
+  class Rule
+    attr_reader :condition, :block
+    def initialize(condition, &block)
+      @condition, @block = condition, block
+    end
+  end
+
+  class DSL
+    attr_reader :rules
+    def initialize
+      @rules = RuleList.new
+    end
+
+    def rule(condition, &block)
+      self.rules << Rule.new(condition, &block)
+    end
+  end
+
+  module DateExts
+    def weekend?
+      self.saturday? || self.sunday?
+    end
+
+    def weekday?
+      !self.weekend?
+    end
+
+    def last_day_of_a_month?
+      self == Date.new(self.year, self.month, -1)
+    end
+  end
+end

data/schedule-dsl.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |spec|
+  spec.name = 'schedule-dsl'
+  spec.version = '0.0.1'
+  spec.license = 'MIT' # Just so gem build would shut up. Use it however you like.
+
+  spec.summary = "Provides a DSL for defining your schedule rules and getting results for given date."
+  spec.author = "Jakub Šťastný"
+  spec.homepage = 'https://github.com/jakub-stastny/schedule-dsl'
+
+  spec.files = Dir["{lib,spec}/**/*.rb"] + ['Gemfile', 'Gemfile.lock', 'README.md', 'schedule-dsl.gemspec']
+end

data/spec/data/basic.rb

@@ -0,0 +1,11 @@
+rule Proc.new { true } do
+  "Go swimming"
+end
+
+rule Proc.new { false } do
+  "Steal things from little kids"
+end
+
+rule -> (date) { date.tuesday? } do
+  "Read a book"
+end

data/spec/data/standard.rb

@@ -0,0 +1,9 @@
+rule -> (date) { date.tuesday? } do |time_frames|
+  time_frames[:morning] << "Go swimming"
+end
+
+# Date#weekday? is one of the custom date extensions
+# defined in Schedule::DateExts.
+rule -> (date) { date.weekday? } do |time_frames|
+  time_frames[:evening] << "Read a book"
+end

data/spec/schedule_spec.rb

@@ -0,0 +1,63 @@
+require 'schedule'
+
+describe Schedule do
+  describe '.load(path)' do
+    it "loads an empty file and returns an empty definition table" do
+      expect(described_class.load('spec/data/empty.rb')).to be_empty
+    end
+
+    it "loads definitions from a file and returns the definition table" do
+      expect(described_class.load('spec/data/basic.rb')).not_to be_empty
+    end
+  end
+
+  let(:date) do
+    Date.new(2020, 12, 1)
+  end
+
+  context "basic rule list" do
+    let(:table) do
+      described_class.load('spec/data/basic.rb')
+    end
+
+    describe '#filter' do
+      it "returns a filtered list of rules which evaluated true for given date" do
+        expect(table.filter(date).length).to eql(2)
+      end
+    end
+
+    describe '#evaluate' do
+      subject { table.filter(date) }
+
+      it "returns a list of outputs that were evaluated from each rule's block" do
+        expect(subject.evaluate).to eql(["Go swimming", "Read a book"])
+      end
+    end
+  end
+
+  context "standard rule list" do
+    let(:time_frames) {{
+      morning: Array.new,
+      evening: Array.new
+    }}
+
+    let(:table) do
+      described_class.load('spec/data/standard.rb')
+    end
+
+    describe '#filter' do
+      it "returns a filtered list of rules which evaluated true for given date" do
+        expect(table.filter(date).length).to eql(2)
+      end
+    end
+
+    describe '#evaluate' do
+      subject { table.filter(date) }
+
+      it "returns a list of outputs that were evaluated from each rule's block" do
+        subject.evaluate(time_frames)
+        expect(time_frames).to eql(morning: ["Go swimming"], evening: ["Read a book"])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: schedule-dsl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jakub Šťastný
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/schedule.rb
+- schedule-dsl.gemspec
+- spec/data/basic.rb
+- spec/data/empty.rb
+- spec/data/standard.rb
+- spec/schedule_spec.rb
+homepage: https://github.com/jakub-stastny/schedule-dsl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Provides a DSL for defining your schedule rules and getting results for given
+  date.
+test_files: []