crease 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffe0dc0ffb7fd2e806caf07209cf80c4c8dc2d60
+  data.tar.gz: 5cecc40b58f2c6ae4bc150ed75ba380d37cfa653
+SHA512:
+  metadata.gz: 56ad2f40fe707a4796eabeccb210e7ef242de23650c781fe1bc5aa98c5ba879449b69fecfb415ef5c2cd9ac0fb0dd8c5526bbc48204c5dfd8404068e813d11cc
+  data.tar.gz: c7bfb0b67ae2c887465e68877c9017ebe3f35a9141d8cd4c5464e3ac5ccf56a28811a001ecc5a4873e08ded54e5e1c3b62831a014e8a71cf03fc353db54a253f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

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 cloydster@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crease.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matt Cloyd
+
+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,131 @@
+# Crease
+
+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.
+
+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.
+
+With Crease, you can write:
+
+```ruby'
+# app/views/city/report.html.erb
+<p>
+  In <%= @city.name %>, the total population
+  <%= increased.by @city.population_in_2000, @city.population_in_2010 %>,
+  <%= an.increase.of(@city.population_in_2000, @city.population_in_2010).percent %>,
+<p>
+```
+
+For Boston, this evaluates to:
+
+```
+<p>
+  In Boston, the total population increased by 30,018, an increase of 105%.
+<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%.
+<p>
+```
+
+#### Examples
+
+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'
+  # `#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'
+```
+
+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.
+
+```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).to_s  #=> 'increased by 1.0'
+```
+
+For dynamic templates, pass in variables instead of fixed numbers.
+
+#### Options
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rubyinc
+gem 'crease'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install crease
+
+#### Rails
+
+Include the `TextHelpers` module in your `ApplicationHelper`, or a more specific
+helper if appropriate.
+
+```ruby
+# app/helpers/application_helper.rb
+
+class ApplicationHelper
+  include Crease::TextHelpers
+
+  # ... other helper code
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/beechnut/crease. 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.
+
+## 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.
+- 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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crease"
+
+# 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

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/crease.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crease/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crease"
+  spec.version       = Crease::VERSION
+  spec.authors       = ["Matt Cloyd"]
+  spec.email         = ["cloydster@gmail.com"]
+
+  spec.summary       = %q{Generate dynamic text about increasing and decreasing numbers.}
+  spec.description   = %q{
+    If you're writing a dynamic, data-driven narrative, you might need to have
+    text like "an increase of 10%" or "decreased by 2", depending on parameters.
+    With Crease, you can include text helpers to write English-like code which
+    changes the text based on the parameters you pass it.
+
+    Crease can calculate the difference between numbers and can represent them
+    as percentages.
+  }
+  spec.homepage      = "https://github.com/beechnut/crease"
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/crease/builder.rb

@@ -0,0 +1,102 @@
+module Crease
+  class Builder
+
+    def criteria
+      @criteria ||= {}
+    end
+
+    def initialize(context: nil, tense: :present)
+      criteria.merge!({ context: context, tense: tense })
+      self
+    end
+
+    def increase
+      criteria.merge!({ tense: :present })
+      self
+    end
+
+    alias_method :decrease, :increase
+
+    def by(*args, sigfig: 2)
+      criteria.merge!({ word: :by })
+      criteria.merge!({ args: args.map(&:to_f) })
+      criteria.merge!({ sigfig: sigfig })
+      self
+    end
+
+    def of(*args, sigfig: 2)
+      criteria.merge!({ word: :of })
+      criteria.merge!({ args: args.map(&:to_f) })
+      criteria.merge!({ sigfig: sigfig })
+      self
+    end
+
+    def to_s
+      if criteria[:percent]
+        "#{base_string} #{percent_change}%"
+      else
+        "#{base_string} #{value}"
+      end
+    end
+
+    def percent
+      criteria.merge!({ 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 article
+      return unless criteria[:context]
+      # Could use ActiveSupport #indefinitize
+      if increase_or_decrease == :increase
+        'an '
+      elsif increase_or_decrease == :decrease
+        'a '
+      end
+    end
+
+    def increase_or_decrease
+      args = criteria[:args]
+      if args.count == 2
+        args.last > args.first ? :increase : :decrease
+      else
+        args.first > 0 ? :increase : :decrease
+      end
+    end
+
+    def value
+      base_calculation.round(criteria[:sigfig])
+    end
+
+    def percent_change
+      args = criteria[:args]
+      if args.count == 2
+        if args.last > args.first
+          base_calculation
+        else
+          base_calculation.abs / args.first
+        end * 100.to_f
+      else
+        base_calculation
+      end.round(criteria[:sigfig])
+    end
+
+    def base_calculation
+      args = criteria[:args]
+      if args.count == 2
+        (args.last - args.first).abs
+      else
+        args.first.abs
+      end
+    end
+
+  end
+end

data/lib/crease/text_helpers.rb

@@ -0,0 +1,19 @@
+module Crease
+  module TextHelpers
+
+    def increased
+      Crease::Builder.new(tense: :past)
+    end
+
+    alias_method :decreased, :increased
+
+    def an
+      Crease::Builder.new(context: :an)
+    end
+
+    def a
+      Crease::Builder.new(context: :a)
+    end
+
+  end
+end

data/lib/crease/version.rb

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

data/lib/crease.rb

@@ -0,0 +1,6 @@
+require "crease/version"
+require "crease/builder"
+require "crease/text_helpers"
+
+module Crease
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: crease
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matt Cloyd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n    If you're writing a dynamic, data-driven narrative, you might
+  need to have\n    text like \"an increase of 10%\" or \"decreased by 2\", depending
+  on parameters.\n    With Crease, you can include text helpers to write English-like
+  code which\n    changes the text based on the parameters you pass it.\n\n    Crease
+  can calculate the difference between numbers and can represent them\n    as percentages.\n
+  \ "
+email:
+- cloydster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crease.gemspec
+- lib/crease.rb
+- lib/crease/builder.rb
+- lib/crease/text_helpers.rb
+- lib/crease/version.rb
+homepage: https://github.com/beechnut/crease
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generate dynamic text about increasing and decreasing numbers.
+test_files: []