trice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8941c189a7c1758706c4f3b6b1a6c89b223e3ea
+  data.tar.gz: 980ad43b5c5df52c0ad1023623237cf268f10d88
+SHA512:
+  metadata.gz: b74981f6f7da1ba1d29ff3b0e85148e5086d1ba03983cddcfeed7412b4bbf3094f387ffa0dbb265fe238f442949ee1d4b3ae0203654e5cbd61c3e277845064b0
+  data.tar.gz: 0b2c51d25d9927fbd22d141bb3da90e6e24f1c384e4fcf9aad1e79211ffcc0c0b3b9b43364b97182145d934b81e64ea825af56d2631a9a7a04705bb04052fdd0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/support/fake_rails_app/log/*

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--order random
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trice.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cookpad Inc.
+
+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,177 @@
+# Trice
+
+Provides **reference time** concept to application. Use it instead of ad-hoc `Time.now`.
+
+### Setting consistent reference time
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trice'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+### With Rails controller
+
+This gem aims to serve consistency of time handling using refrence time to Rails application.
+The layer which should set reference time is controller layer, because reference time is one of external input.
+
+Include `Trice::ControllerMethods` to your controller
+
+```ruby
+class ApplicationController < AC::Base
+  include Trice::ControllerMethods
+end
+```
+
+Then your controller and view gets an accessor method to access consistent time object.
+
+- `requested_at`: returns timestamp of action invoked (or stubbed timestamp, see below).
+
+### Include helper module outside of controller
+
+Inlude `Trice::ReferenceTime` add `#reference_time` method to lookup current reference time.
+
+Use it in Rails model.
+
+```ruby
+class MyWork
+  include Trice::ReferenceTime
+
+  def do!(at: nil)
+    self.done_at = at || reference_time
+  end
+end
+```
+
+### Setting consistent reference time
+
+Set reference time with `Trice.refrence_time = _time_` or `Trice.with_refrence_time(_time_, &block)`.
+Accessible by `Trice.reference_time`..
+
+```ruby
+p Time.now
+=> 2016-02-01 11:25:37 +0900
+
+Trice.with_refrence_time = Time.iso8601('2016-02-01T09:00:00Z')
+p Trice.reference_time
+# => 2016-02-01 09:00:00 UTC
+
+Trice.with_refrence_time(Time.iso8601('2016-02-01T10:00:00Z')) do
+  p Trice.reference_time
+  # => 2016-02-01 10:00:00 UTC
+end
+
+Trice.with_refrence_time = nil
+p Trice.reference_time
+# => raise Trice::NoReferenceTime
+```
+
+The time is stored in thread local variable.
+
+## Time Stubbing
+
+Trice allows you to stub reference time to run travelled time-testing and / or previewing your app in future time.
+
+Set `_requested_at=<timish>` query parameter like below
+```
+$ curl https://example.com/campaigns/12345?_requested_at=20160215130
+```
+
+Or can set HTTP header, useful for tests.
+```
+X-REQUESTED-AT: 2016-02-15T13:00:00+09:00
+```
+
+Value format, which specified both query parameter and header, should be `Time.parsse` parasable.
+
+#### Enable/Disable stubbing
+
+Toggle requested at stubbing in `config/initializers`. The default is below, enabled unelss `Rails.env.production?`.
+
+```ruby
+Trice.support_performing_at_stubbing = !Rails.env.production?
+```
+
+Setting callable object let you choice enable/disable dinamically by seeing request.
+
+```ruby
+our_office_network = IPAddr.new('203.0.113.0/24')
+
+Trice.support_performing_at_stubbing = ->(controller) {
+  next true unless Rails.env.production?
+
+  our_office_network.include?(controller.request.remote_ip)
+}
+```
+
+## Test helpers
+
+There is a test helper method for feature spec.
+
+```ruby
+RSpec.configure do |config|
+  config.extend Trice::SpecHelper
+end
+```
+
+I recommend to pass reference time to a modle by method and/or constructor argument because reference time is an external input, should be handled controller layer.
+But sometimes it is required  from deep inside of model logics and tests for them.
+
+Model unit spec has `with_refrence_time` and `set_now_to_reference_time` declarition method to set `Trice.reference_time` in an example.
+
+```ruby
+describe MyModel do
+  let(:reference_time) { Time.zone.parse('2016/02/03 12:00') }
+  context  do
+    set_reference_time { refrence_time }
+
+    let(:model) { MyModel.find_by_something(key) }
+
+    specify do
+      # can accessible `reference_time` in MyModel#do_something
+      expect { model.do_something }.not_to raise(Trice::NoReferenceTime)
+    end
+  end
+end
+```
+
+Feature specs (or othre Capybara based E2E tests) also has helper method using stubbing mechanism. `stub_requested_at <timish>` set `X-Trice-Requested-At` automatically.
+
+```ruby
+context 'on ひな祭り day' do
+  stub_requested_at Time.zone.parse('2016-03-03 10:00')
+
+  scenario 'See Hinamatsuri special banner at 3/3 request' do
+    visit root_path
+    within '#custom-header' do
+      expect(page).to contain 'ひな祭り'
+    end
+  end
+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/cookpad/trice.
+
+
+## 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 "trice"
+
+# 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/lib/trice.rb

@@ -0,0 +1,19 @@
+require 'active_support/all'
+
+require 'trice/controller_methods'
+require 'trice/errors'
+require 'trice/reference_time'
+require 'trice/reference_time_accessor'
+require 'trice/version'
+
+if defined?(Rails)
+  require 'trice/railtie'
+end
+
+module Trice
+  autoload 'SpecHelper', 'trice/spec_helper'
+
+  extend ReferenceTimeAccessor
+
+  mattr_accessor :support_requested_at_stubbing
+end

data/lib/trice/controller_methods.rb

@@ -0,0 +1,23 @@
+require 'trice/controller_methods/reference_time_assignment'
+require 'trice/controller_methods/stub_configuration'
+
+module Trice
+  module ControllerMethods
+
+    extend ActiveSupport::Concern
+
+    included do |controller|
+      if controller.ancestors.include?(ActionController::Base)
+        config = StubConfiguration.new(Trice.support_requested_at_stubbing)
+        prepend_around_action ReferenceTimeAssignment.new(config)
+
+        helper_method :requested_at
+        hide_action   :requested_at
+      end
+    end
+
+    def requested_at
+      Trice.reference_time
+    end
+  end
+end

data/lib/trice/controller_methods/reference_time_assignment.rb

@@ -0,0 +1,39 @@
+module Trice
+  module ControllerMethods
+    class ReferenceTimeAssignment
+
+      QUERY_STUB_KEY  = '_requested_at'.freeze
+      HEADER_STUB_KEY = 'X-REQUESTED-AT'.freeze
+
+      def initialize(config)
+        @stub_configuration = config
+      end
+
+      def around(controller, &action)
+        t = determine_requested_at(controller)
+
+        controller.request.env['trice.reference_time'] = t
+
+        Trice.with_reference_time(t, &action)
+      end
+
+      private
+
+      def determine_requested_at(controller)
+        if @stub_configuration.stubbable?(controller)
+          extract_requested_at(controller.request) || Time.now
+        else
+          Time.now
+        end
+      end
+
+      def extract_requested_at(request)
+        if request.params[QUERY_STUB_KEY]
+          Time.zone.parse(request.params[QUERY_STUB_KEY])
+        elsif request.headers[HEADER_STUB_KEY]
+          Time.zone.parse(request.headers[HEADER_STUB_KEY])
+        end
+      end
+    end
+  end
+end

data/lib/trice/controller_methods/stub_configuration.rb

@@ -0,0 +1,14 @@
+module Trice
+  module ControllerMethods
+    class StubConfiguration
+      def initialize(condition)
+        @condition = condition
+        @is_callable = @condition.respond_to?(:call)
+      end
+
+      def stubbable?(request)
+        @is_callable ? @condition.call(request) : !!@condition
+      end
+    end
+  end
+end

data/lib/trice/errors.rb

@@ -0,0 +1,4 @@
+module Trice
+  class Error < StandardError; end
+  class NoReferenceTime < Error; end
+end

data/lib/trice/railtie.rb

@@ -0,0 +1,7 @@
+module Trice
+  class Railtie < ::Rails::Railtie
+    initializer 'trice' do |app|
+      Trice.support_requested_at_stubbing = !Rails.env.production?
+    end
+  end
+end

data/lib/trice/reference_time.rb

@@ -0,0 +1,7 @@
+module Trice
+  module ReferenceTime
+    def reference_time
+      Trice.reference_time
+    end
+  end
+end

data/lib/trice/reference_time_accessor.rb

@@ -0,0 +1,11 @@
+require 'trice/repository'
+
+module Trice
+  module ReferenceTimeAccessor
+    def self.repository
+      @repository ||= Repository.new
+    end
+
+    delegate :reference_time=, :reference_time, :with_reference_time, to: 'Trice::ReferenceTimeAccessor.repository'
+  end
+end

data/lib/trice/repository.rb

@@ -0,0 +1,43 @@
+module Trice
+  class Repository
+    def initialize
+      @backend = ThreadLocalBackend.new('trice.reference_time'.freeze)
+    end
+
+    def reference_time=(time)
+      unless time.nil? || time.acts_like?(:time)
+        raise ArgumentError, "#{time.inspect} is not behave like time"
+      end
+      @backend.set(time)
+    end
+
+    def reference_time
+      @backend.get || raise(NoReferenceTime)
+    end
+
+    def with_reference_time(time, &block)
+      original = @backend.get
+
+      begin
+        self.reference_time = time
+        yield time
+      ensure
+        self.reference_time = original
+      end
+    end
+  end
+
+  class ThreadLocalBackend
+    def initialize(key)
+      @key = key
+    end
+
+    def set(time)
+      Thread.current[@key] = time
+    end
+
+    def get
+      Thread.current[@key]
+    end
+  end
+end

data/lib/trice/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'trice/errors'
+
+module Trice
+  module SpecHelper
+    def self.extract_time(runtime, static_time, block)
+      block ? runtime.instance_eval(&block) : static_time
+    end
+
+    def set_reference_time(static_time = nil, &block)
+      around(:each) do |ex|
+        time = SpecHelper.extract_time(self, static_time, block)
+
+        Trice.with_reference_time(time) { ex.run }
+      end
+    end
+
+    def set_now_as_reference_time
+      set_reference_time(Time.now)
+    end
+
+    def stub_requested_at(static_time = nil, &block)
+      before(:each) do |ex|
+        time = SpecHelper.extract_time(self, static_time, block)
+
+        case ex.metadata[:type]
+        when :controller
+          request.headers['X-Requested-At'] = time.iso8601
+        when :feature
+          page.driver.header 'X-Requested-At', time.iso8601
+        else
+          raise Trice::TestStubbingNotSupported, "Test stubbing for type: #{ex.metadata[:type]} is not supported"
+        end
+      end
+    end
+  end
+end

data/lib/trice/version.rb

@@ -0,0 +1,3 @@
+module Trice
+  VERSION = "0.1.0"
+end

data/trice.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trice"
+  spec.version       = Trice::VERSION
+  spec.authors       = ["moro"]
+  spec.email         = ["kyosuke-morohashi@cookpad.com"]
+
+  spec.summary       = %q{Provides reference time concept to application. Use it instead of ad-hoc `Time.now`}
+  spec.homepage      = "https://github.com/cookpad/trice"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.0"
+  spec.add_development_dependency "actionpack", "~> 4.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: trice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- moro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- kyosuke-morohashi@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/trice.rb
+- lib/trice/controller_methods.rb
+- lib/trice/controller_methods/reference_time_assignment.rb
+- lib/trice/controller_methods/stub_configuration.rb
+- lib/trice/errors.rb
+- lib/trice/railtie.rb
+- lib/trice/reference_time.rb
+- lib/trice/reference_time_accessor.rb
+- lib/trice/repository.rb
+- lib/trice/spec_helper.rb
+- lib/trice/version.rb
+- trice.gemspec
+homepage: https://github.com/cookpad/trice
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Provides reference time concept to application. Use it instead of ad-hoc
+  `Time.now`
+test_files: []