crease 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffe0dc0ffb7fd2e806caf07209cf80c4c8dc2d60
-  data.tar.gz: 5cecc40b58f2c6ae4bc150ed75ba380d37cfa653
+  metadata.gz: 67e2fe93fb2d9c22afd67774b5a2f443d5f20489
+  data.tar.gz: 663d9fac09068a14f094a1cd5bce8dada3f46a41
 SHA512:
-  metadata.gz: 56ad2f40fe707a4796eabeccb210e7ef242de23650c781fe1bc5aa98c5ba879449b69fecfb415ef5c2cd9ac0fb0dd8c5526bbc48204c5dfd8404068e813d11cc
-  data.tar.gz: c7bfb0b67ae2c887465e68877c9017ebe3f35a9141d8cd4c5464e3ac5ccf56a28811a001ecc5a4873e08ded54e5e1c3b62831a014e8a71cf03fc353db54a253f
+  metadata.gz: 6b858fcd0cc79f8021dfd8d63ae870cbf48b76edd158818cfbaa803c9f17b6d31029ae175be9abfb2dc1ca1b8b3f0a5c6935440410c268db3ee7259f0eab874f
+  data.tar.gz: a450e8fc73d088ae9d629c16cb93dd15c3a04918c195b4c676f4077c37a0a457224c2937a572c3c0ba6a07e4885ccc42bfd9d3a55c724f370545ca6e45c9e008

data/README.md

@@ -4,17 +4,15 @@ Generate dynamic text about increasing and decreasing numbers.
 
 ## Usage
 
-Let's say you're writing a dynamic report that needs to put data in context,
-explaining it in simple English.
+Let's say you're writing a dynamic report that needs to put data in context, explaining it in simple English.
 
-You want to tell the world that thetotal population of Boston increased, and
-that the total population in Pittsburgh decreased, but you only want to write
-one template that takes in data from each city and displays the right text.
+You want to tell the world that the total population of Boston increased, and that the total population in Pittsburgh decreased, but you only want to write one template that takes in data from each city and displays the right text.
 
-With Crease, you can write:
+
+__With Crease, you just write:__
 
 ```ruby'
-# app/views/city/report.html.erb
+# In any ERb (or Haml) template, i.e. app/views/city/report.html.erb
 <p>
   In <%= @city.name %>, the total population
   <%= increased.by @city.population_in_2000, @city.population_in_2010 %>,
@@ -22,24 +20,28 @@ With Crease, you can write:
 <p>
 ```
 
+And it will work for both cities.
+
+
 For Boston, this evaluates to:
 
 ```
 <p>
-  In Boston, the total population increased by 30,018, an increase of 105%.
+  In Boston, the total population increased by 30,018, an increase of 5.08%%.
 <p>
 ```
 
-> Note: we think that '105%' here is misleading: see the roadmap for more.
-
 For Pittsburgh, the same template evaluates to:
 
 ```
 <p>
-  In Pittsburgh, the total population decreased by 28,068, an decrease of 8.4%.
+  In Pittsburgh, the total population decreased by 28,068, an decrease of 8.41%.
 <p>
 ```
 
+> Source of the above data: [Boston](https://www.google.com/#q=boston+population+2010) | [Pittsburgh](https://www.google.com/#q=pittsburgh+population+2010)
+
+
 #### Examples
 
 The following are examples of text you can write with Crease.
@@ -47,27 +49,50 @@ The following are examples of text you can write with Crease.
 ```ruby
 # In the context of a template
 
-increased.by(1)            #=> 'increased by 1.0'
-increased.by(-1)           #=> 'decreased by 1.0'
-increased.by(2, 4)         #=> 'increased by 2.0'
-decreased.by(2, 4)         #=> 'increased by 2.0'
+# Increase or decrease with one number
+increased.by(1)            #=> "increased by 1.0"
+increased.by(-1)           #=> "decreased by 1.0"
+
+# Increase or decrease with two numbers
+increased.by(2, 4)         #=> "increased by 2.0"
+an.increase.of(2)          #=> "an increase of 2.0"
+decreased.by(2, 4)         #=> "increased by 2.0"
   # `#decreased` is just an alias for `#increased`
-increased.by(1).percent    #=> 'increased by 1.0%'
-increased.by(2, 4).percent #=> 'increased by 200.0%'
-  # kind of misleading, will change in next release
-an.increase.of(2)          #=> 'an increase of 2.0'
+
+# Percent increase or decrease with one number, percent
+increased.by(1).percent    #=> "increased by 1.0%"
+
+# Percent increase or decrease with two numbers, percent
+increased.by(2, 4).percent #=> "increased by 100.0%"
+increased.by(4, 1).percent #=> "decreased by 75.0%"
+
+# Change with one number
+a.change.of(2) #=> "a change of 2.0"
+changed.by(-2) #=> "changed by -2.0"
+
+# Change with two numbers
+changed.by(1, 2) #=> "changed by 1.0"
+a.change.of(4, 2) #=> "a change of -2.0"
+
+# Percent change with one numbers
+changed.by(2).percent #=> "changed by 2.0%"
+a.change.of.by(2).percent #=> "changed by 2.0%"
+
+# Percent change with two numbers
+changed.by(2, 4).percent   #=> "changed by 200.0%"
+a.change.of(2, 4).percent  #=> "a change of 200.0%"
+a.change.of(4, 1).percent  #=> "a change of -300.0%"
+  # This is a little misleading, and will be taken under advisement.
 ```
 
-Inside templates, these method chains will be implicitly converted to strings,
-with ERb or Haml calling `#to_s` on them.
+Inside templates, these method chains will be implicitly converted to strings, with ERb or Haml calling `#to_s` on them.
 
-If you are working with these outside of a template, you'll need to call `#to_s`
-at the end of the method chain yourself.
+If you are working with these outside of a template, you'll need to call `#to_s` at the end of the method chain yourself.
 
 ```ruby
 # Outside a template
 
-increased.by(1)       #=> #<Crease::Builder:0x007fecf8a35c90 @criteria={:context=>nil, :tense=>:past, :word=>:by, :args=>[1.0], :sigfig=>2}>
+increased.by(1)       #=> #<Crease::Builder:0x007fdaa19a6db0 @before=nil, @subject=nil, @after=:by, @args=[1.0], @percent=false, @tense=:past, @sigfig=2>
 increased.by(1).to_s  #=> 'increased by 1.0'
 ```
 
@@ -91,10 +116,10 @@ Or install it yourself as:
 
     $ gem install crease
 
+
 #### Rails
 
-Include the `TextHelpers` module in your `ApplicationHelper`, or a more specific
-helper if appropriate.
+Include the TextHelpers module in your ApplicationHelper.
 
 ```ruby
 # app/helpers/application_helper.rb
@@ -106,6 +131,20 @@ class ApplicationHelper
 end
 ```
 
+You can optionally configure Crease to convert all results to integers, or set a number of significant digits to round to.
+
+```ruby
+# Create a file config/initializers/crease.rb
+
+Crease.configure do |config|
+  # Round every result to a specific number of significant digits.
+  config.digits  = 3    # Defaults to 2.
+
+  # Convert every result to integer. This option ignores the digits option.
+  config.integer = true # Defaults to false.
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -118,11 +157,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/beechn
 
 ## Roadmap
 
-- Significant digits are passed in differently from other options, and we're not testing whether it's possible to convert them to integers.
-- We'd like to have a way to configure the gem -- for Rails, in an initializer -- so that we can specify default significant figures there. If someone wants everything to be an integer by default, it would be easier to do it there.
-  - Might even allow a Proc-based option that sets sigfigs dynamically.
+- Allow a Proc-based option that sets sigfigs dynamically.
 - Add documentation about understanding sigfigs.
-- Right now, `increased.by(2, 4).percent` returns "increased by 200.0%", which is a little misleading. We want `changed.by(2, 4).percent` to say "changed by 200.0%", and `increased.by(2, 4).percent` to say "increased by 100%".
+
 
 
 ## License

data/lib/crease.rb

@@ -1,4 +1,5 @@
 require "crease/version"
+require "crease/configuration"
 require "crease/builder"
 require "crease/text_helpers"
 

data/lib/crease/builder.rb

@@ -1,100 +1,142 @@
 module Crease
   class Builder
 
-    def criteria
-      @criteria ||= {}
-    end
+    def initialize(before: nil, subject: nil, after: nil, args: [], percent: false, tense: nil)
+      @before  = before
+      @subject = subject
+      @after   = after
+      @args    = args
+      @percent = percent
+      @tense   = tense
 
-    def initialize(context: nil, tense: :present)
-      criteria.merge!({ context: context, tense: tense })
       self
     end
 
     def increase
-      criteria.merge!({ tense: :present })
+      @tense = :present
       self
     end
 
     alias_method :decrease, :increase
 
+    def change
+      @subject = :change
+      self
+    end
+
     def by(*args, sigfig: 2)
-      criteria.merge!({ word: :by })
-      criteria.merge!({ args: args.map(&:to_f) })
-      criteria.merge!({ sigfig: sigfig })
+      @after  = :by
+      @args   = args.map(&:to_f)
+      @sigfig = sigfig
       self
     end
 
     def of(*args, sigfig: 2)
-      criteria.merge!({ word: :of })
-      criteria.merge!({ args: args.map(&:to_f) })
-      criteria.merge!({ sigfig: sigfig })
+      @after  = :of
+      @args   = args.map(&:to_f)
+      @sigfig = sigfig
       self
     end
 
     def to_s
-      if criteria[:percent]
-        "#{base_string} #{percent_change}%"
+      if @percent
+        "#{phrase} #{percent_value}%"
       else
-        "#{base_string} #{value}"
+        "#{phrase} #{value}"
       end
     end
 
     def percent
-      criteria.merge!({ percent: true })
+      @percent = true
       self
     end
 
-    def base_string
-      past = criteria[:tense] == :past ? 'd' : ''
-      str = "#{article}#{increase_or_decrease}#{past}"
-      str << " #{criteria[:word]}" if criteria[:word]
-      str
-    end
-
     private
 
+    def phrase
+      "#{article} #{subject} #{after}".strip
+    end
+
     def article
-      return unless criteria[:context]
-      # Could use ActiveSupport #indefinitize
-      if increase_or_decrease == :increase
-        'an '
-      elsif increase_or_decrease == :decrease
-        'a '
+      if @before
+        indefinitize(subject)
+      end
+    end
+
+    def subject # increase, decrease, or change
+      word = if @subject.to_s == 'change'
+        word = 'change'
+      else
+        increase_or_decrease
+      end
+      if @tense.to_s == 'past'
+        word << 'd'
+      else
+        word
+      end
+    end
+
+    def after
+      @after
+    end
+
+    def indefinitize(subject)
+      if subject.match /increase/
+        'an'
+      elsif subject.match /decrease|change/
+        'a'
       end
     end
 
     def increase_or_decrease
-      args = criteria[:args]
-      if args.count == 2
-        args.last > args.first ? :increase : :decrease
+      if @args.count == 2
+        @args.last > @args.first ? 'increase' : 'decrease'
       else
-        args.first > 0 ? :increase : :decrease
+        @args.first > 0 ?          'increase' : 'decrease'
       end
     end
 
     def value
-      base_calculation.round(criteria[:sigfig])
+      apply_filters(@subject.to_s == 'change' ? difference : difference.abs)
+    end
+
+    def percent_value
+      apply_filters(@subject.to_s == 'change' ? percent_change : percent_difference.abs)
+    end
+
+    def percent_difference
+      if @args.count == 2
+        (difference / @args.first).to_f * 100
+      else
+        @args.first
+      end
     end
 
     def percent_change
-      args = criteria[:args]
-      if args.count == 2
-        if args.last > args.first
-          base_calculation
+      if @args.count == 2
+        if @args.last > @args.first
+          (@args.last / @args.first).to_f * 100
         else
-          base_calculation.abs / args.first
-        end * 100.to_f
+          ((@args.first - @args.last) / @args.last).to_f * -100
+        end
       else
-        base_calculation
-      end.round(criteria[:sigfig])
+        @args.first
+      end
+    end
+
+    def difference
+      if @args.count == 2
+        (@args.last - @args.first)
+      else
+        @args.first
+      end
     end
 
-    def base_calculation
-      args = criteria[:args]
-      if args.count == 2
-        (args.last - args.first).abs
+    def apply_filters(number)
+      if Crease.configuration.integer
+        number.to_i
       else
-        args.first.abs
+        number.round(@sigfig || Crease.configuration.digits)
       end
     end
 

data/lib/crease/configuration.rb

@@ -0,0 +1,20 @@
+module Crease
+
+  def self.configuration
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :digits, :integer
+
+    def initialize(digits: 2, integer: false)
+      @digits = digits
+      @integer = integer
+    end
+  end
+end

data/lib/crease/text_helpers.rb

@@ -8,11 +8,15 @@ module Crease
     alias_method :decreased, :increased
 
     def an
-      Crease::Builder.new(context: :an)
+      Crease::Builder.new(before: :an)
     end
 
     def a
-      Crease::Builder.new(context: :a)
+      Crease::Builder.new(before: :a)
+    end
+
+    def changed
+      Crease::Builder.new(subject: :change, tense: :past)
     end
 
   end

data/lib/crease/version.rb

@@ -1,3 +1,3 @@
 module Crease
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crease
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matt Cloyd
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - crease.gemspec
 - lib/crease.rb
 - lib/crease/builder.rb
+- lib/crease/configuration.rb
 - lib/crease/text_helpers.rb
 - lib/crease/version.rb
 homepage: https://github.com/beechnut/crease