smartdown 0.9.0 → 0.10.0

data/README.md

@@ -127,6 +127,21 @@ country slugs/names.
 [date: baby_due_date]
 ```
 
+To control the range of years selected you can supply 2 optional arguments to date questions: `from` and `to`.
+These can take the form of absolute values, eg.
+
+```markdown
+[date: baby_due_date, from: 2010, to: 2015]
+```
+
+Or relative values (from the current year), eg.
+
+```markdown
+[date: baby_due_date, from: -4, to: 1]
+```
+
+The default values for `from` and `to` are relative years: `-1` and `3` respectively.
+
 ### Text
 
 ```markdown

data/lib/smartdown/api/date_question.rb

@@ -3,6 +3,39 @@ require 'smartdown/api/question'
 module Smartdown
   module Api
     class DateQuestion < Question
+      extend Forwardable
+      DEFAULT_START_YEAR = Time.now.year - 1
+      DEFAULT_END_YEAR = Time.now.year + 3
+
+      def start_year
+        parse_date(from) || DEFAULT_START_YEAR
+      end
+
+      def end_year
+        parse_date(to) || DEFAULT_END_YEAR
+      end
+
+    private
+
+      delegate [:to, :from] => :question_element
+
+      def question_element
+        @question_element ||= elements.find{|element| element.is_a? Smartdown::Model::Element::Question::Date}
+      end
+
+      def parse_date(date_string)
+        return nil unless date_string
+        year = date_string.to_i
+        if is_fixed_year?(year)
+          year
+        else
+          Time.now.year + year
+        end
+      end
+
+      def is_fixed_year?(int)
+        int.abs >= 1000
+      end
     end
   end
 end

data/lib/smartdown/engine/interpolator.rb

@@ -41,7 +41,10 @@ module Smartdown
         def interpolate(text, state)
           text.to_s.gsub(/%{([^}]+)}/) do |_|
             term = resolve_term($1, state)
-            term.respond_to?(:humanize) ? term.humanize : term
+            if term.is_a?(Smartdown::Model::Answer::Base)
+              term = term.humanize
+            end
+            term
           end
         end
 

data/lib/smartdown/model/element/question/date.rb

@@ -4,7 +4,7 @@ module Smartdown
   module Model
     module Element
       module Question
-        class Date < Struct.new(:name, :alias)
+        class Date < Struct.new(:name, :from, :to, :alias)
           def answer_type
             Smartdown::Model::Answer::Date
           end

data/lib/smartdown/parser/flow_interpreter.rb

@@ -13,7 +13,11 @@ module Smartdown
       end
 
       def to_s(full = true)
-        "Parse error in '#{filename}':\n\n" + @parse_error.cause.ascii_tree
+        position = parse_error.cause.pos
+        line, column = parse_error.cause.source.line_and_column(position)
+
+        "Parse error in file:'#{filename}' line:'#{line}' column:'#{column}'" +
+        "\n\n" + parse_error.cause.ascii_tree
       end
     end
 

data/lib/smartdown/parser/node_interpreter.rb

@@ -7,7 +7,7 @@ require 'smartdown/parser/node_transform'
 module Smartdown
   module Parser
     class NodeInterpreter
-      attr_reader :name, :source
+      attr_reader :name, :source, :reporter
 
       def initialize(name, source, options = {})
         @name = name
@@ -15,10 +15,11 @@ module Smartdown
         data_module = options.fetch(:data_module, {})
         @parser = options.fetch(:parser, Smartdown::Parser::NodeParser.new)
         @transform = options.fetch(:transform, Smartdown::Parser::NodeTransform.new(data_module))
+        @reporter = options.fetch(:reporter, Parslet::ErrorReporter::Deepest.new)
       end
 
       def interpret
-        transform.apply(parser.parse(source),
+        transform.apply(parser.parse(source, reporter: reporter),
           node_name: name
         )
       end

data/lib/smartdown/parser/node_transform.rb

@@ -102,9 +102,12 @@ module Smartdown
       }
 
       rule(:date => {identifier: simple(:identifier), :option_pairs => subtree(:option_pairs)}) {
+        transformed_option_pairs = Smartdown::Parser::OptionPairs.transform(option_pairs)
         Smartdown::Model::Element::Question::Date.new(
           identifier.to_s,
-          Smartdown::Parser::OptionPairs.transform(option_pairs).fetch('alias', nil)
+          transformed_option_pairs.fetch('from', nil),
+          transformed_option_pairs.fetch('to', nil),
+          transformed_option_pairs.fetch('alias', nil),
         )
       }
 

data/lib/smartdown/parser/predicates.rb

@@ -45,6 +45,7 @@ module Smartdown
         equality_predicate.as(:equality_predicate) |
         set_membership_predicate.as(:set_membership_predicate) |
         comparison_predicate.as(:comparison_predicate) |
+        function_predicate.as(:function_predicate) |
         otherwise_predicate |
         named_predicate
       }
@@ -68,7 +69,6 @@ module Smartdown
 
       rule (:predicates) {
         combined_predicate.as(:combined_predicate) |
-        function_predicate.as(:function_predicate) |
         predicate
       }
 

data/lib/smartdown/version.rb

@@ -1,3 +1,3 @@
 module Smartdown
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/spec/api/date_question_spec.rb

@@ -0,0 +1,71 @@
+require 'smartdown/api/date_question'
+require 'smartdown/model/element/question/date'
+
+describe Smartdown::Api::DateQuestion do
+  before do
+    Timecop.freeze(Time.local(2014))
+  end
+
+  after do
+    Timecop.return
+  end
+
+  subject(:date_question) { Smartdown::Api::DateQuestion.new(elements) }
+  let(:elements) { [ date_question_element ] }
+  let(:date_question_element) {
+    Smartdown::Model::Element::Question::Date.new(name, *args)
+  }
+  let(:aliaz) { nil }
+  let(:args) {[start_year, end_year, aliaz]}
+
+
+  context "no to/from provided" do
+    let(:name)       { 'year_of_emancipation' }
+    let(:start_year) { nil }
+    let(:end_year)   { nil }
+
+    describe "#start_year" do
+      it 'returns good default' do
+        expect(date_question.start_year).to eq(Time.now.year - 1)
+      end
+    end
+
+    describe "#end_year" do
+      it 'returns good default' do
+        expect(date_question.end_year).to eq(Time.now.year + 3)
+      end
+    end
+  end
+
+  context "with to/from provided" do
+    context "Fixed years" do
+      let(:name)       { 'year_of_incarceration_for_possession_of_alcohol' }
+      let(:start_year) { '1920' }
+      let(:end_year)   { '1933' }
+
+      describe "start_year" do
+        specify { expect(date_question.start_year).to eq(start_year.to_i) }
+      end
+
+      describe "end_year" do
+        specify { expect(date_question.end_year).to eq(end_year.to_i) }
+      end
+    end
+
+    context "Relative years" do
+      let(:name)       { 'year_of_incarceration_for_practicing_witchcraft' }
+      let(:start_year) { '-279' }
+      let(:end_year)   { '-63' }
+
+      describe "start_year" do
+        specify { expect(date_question.start_year).to eq(1735) }
+      end
+
+      describe "end_year" do
+        specify { expect(date_question.end_year).to eq(1951) }
+      end
+
+    end
+  end
+
+end

data/spec/parser/element/date_question_spec.rb

@@ -27,6 +27,38 @@ describe Smartdown::Parser::Element::DateQuestion do
     end
   end
 
+  context "with question tag and a date range with years" do
+    let(:source) { "[date: date_of_birth, from: 1980, to: -2]" }
+
+    it "parses" do
+      should parse(source).as(
+        date: {
+          identifier: "date_of_birth",
+          option_pairs: [
+            {
+              key: 'from',
+              value: '1980',
+            },
+            {
+              key: 'to',
+              value: '-2',
+            }
+          ]
+
+        }
+      )
+    end
+
+    describe "transformed" do
+     let(:node_name) { "my_node" }
+     subject(:transformed) {
+       Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
+     }
+
+     it { should eq(Smartdown::Model::Element::Question::Date.new("date_of_birth", '1980', '-2')) }
+    end
+  end
+
   context "with question tag and an alias" do
     let(:source) { "[date: date_of_birth, alias: date_for_adoption_or_birth]" }
 
@@ -50,7 +82,7 @@ describe Smartdown::Parser::Element::DateQuestion do
         Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
       }
 
-      it { should eq(Smartdown::Model::Element::Question::Date.new("date_of_birth", "date_for_adoption_or_birth")) }
+      it { should eq(Smartdown::Model::Element::Question::Date.new("date_of_birth", nil, nil, "date_for_adoption_or_birth")) }
     end
   end
 end

data/spec/parser/predicates_spec.rb

@@ -82,9 +82,9 @@ describe Smartdown::Parser::Predicates do
   describe "predicate AND predicate" do
     subject(:parser) { described_class.new }
 
-    it { should parse("my_pred? AND my_other_pred?").as(
+    it { should parse("my_pred() AND my_other_pred?").as(
       { combined_predicate: {
-        first_predicate: { named_predicate: "my_pred?" },
+        first_predicate: { function_predicate: { name: "my_pred" } },
         and_predicates:
           [
             {named_predicate: "my_other_pred?"},
@@ -107,16 +107,16 @@ describe Smartdown::Parser::Predicates do
 
     describe "transformed" do
       let(:node_name) { "my_node" }
-      let(:source) { "my_pred? AND my_other_pred?" }
+      let(:source) { "my_pred() AND my_other_pred?" }
       subject(:transformed) {
         Smartdown::Parser::NodeInterpreter.new(node_name, source, parser: parser).interpret
       }
 
       it { should eq(Smartdown::Model::Predicate::Combined.new(
         [
-          Smartdown::Model::Predicate::Named.new("my_pred?"),
+          Smartdown::Model::Predicate::Function.new("my_pred", []),
           Smartdown::Model::Predicate::Named.new("my_other_pred?")
-        ]
+      ]
       )) }
     end
   end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
 require 'pathname'
 require 'parslet/rig/rspec'
 require 'support/model_builder'
+require 'timecop'
 
 RSpec.configure do |config|
   if config.files_to_run.one?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartdown
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &9477660 !ruby/object:Gem::Requirement
+  requirement: &18204100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *9477660
+  version_requirements: *18204100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &9476740 !ruby/object:Gem::Requirement
+  requirement: &18232520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *9476740
+  version_requirements: *18232520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9475460 !ruby/object:Gem::Requirement
+  requirement: &18231800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9475460
+  version_requirements: *18231800
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &9474100 !ruby/object:Gem::Requirement
+  requirement: &18230980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9474100
+  version_requirements: *18230980
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &18230000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18230000
 description: 
 email: david.heath@digital.cabinet-office.gov.uk
 executables:
@@ -176,6 +187,7 @@ files:
 - spec/support/flow_input_interface.rb
 - spec/support/model_builder.rb
 - spec/api/state_spec.rb
+- spec/api/date_question_spec.rb
 - spec/api/previous_question_spec.rb
 - spec/spec_helper.rb
 - spec/engine/state_spec.rb
@@ -252,7 +264,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2036017641587620978
+      hash: 508907290184423365
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -261,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2036017641587620978
+      hash: 508907290184423365
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -295,6 +307,7 @@ test_files:
 - spec/support/flow_input_interface.rb
 - spec/support/model_builder.rb
 - spec/api/state_spec.rb
+- spec/api/date_question_spec.rb
 - spec/api/previous_question_spec.rb
 - spec/spec_helper.rb
 - spec/engine/state_spec.rb