tuto_man 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8eaa86ecdcfb035bcf325f07a4f20405308354f
+  data.tar.gz: d61c82f31db71aa241329150f70f89a662a8ce73
+SHA512:
+  metadata.gz: 5dc38275fbecdb7b7a20be27556e44bc80ae192e21df0336b3c492678bc8afa3a21fe319fbad876abe293a2b5bd45b0e3a9bf962cbf8576f2579e15faaa60ad8
+  data.tar.gz: 9b0d34c5da0e061dae34729bdff96841c5e8aa80e3ad656434ba50d83a3bc7ea6f97a3375167217e8bb8cb2c897e0e0fe1891536adb92d14e47f7fc5ba537b09

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    tuto_man (0.0.1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.2)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  rake
+  rspec
+  tuto_man!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 KRAY Inc.
+
+MIT License
+
+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,49 @@
+# TutoMan
+
+TutoMan manages diplays of tutorial views or reminders in a rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tuto_man'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tuto_man
+
+## Usage
+
+### Configuration
+
+Set display timing for each tutorial or reminders.
+
+```ruby
+# config/initializers/tuto_man.rb
+TutoMan :my_tuto, interval: 7 * 24 * 60 * 60  # once shown suppress for 1 week
+```
+
+### Control
+
+```ruby
+# tell if a tuto is displaying
+tuto(:my_tuto).on?
+
+# mark as shown
+tuto(:my_tuto).shown
+
+# turn off forever
+tuto(:my_tuto).off
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/tuto_man/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tuto_man.rb

@@ -0,0 +1,82 @@
+require "tuto_man/version"
+require "active_support/core_ext"
+
+module TutoManager
+  mattr_reader :tutos
+  @@tutos = {}
+
+  module Register
+    def TutoMan(id, options = {})
+      TutoManager.tutos[id] = options
+    end
+  end
+
+  module Helpers
+    class Tuto
+      def initialize(id, session)
+        @id = id
+        @session = session
+      end
+
+      def off
+        @session[:"_#{@id}_disabled"] = true
+      end
+
+      def on?
+        enabled? && (options[:days_after] ? day_after? : elapsed?)
+      end
+
+      def shown
+        now = Time.now
+        if options[:days_after]
+          @session[:"_next_#{@id}_at"] = (now.mday < options[:days_after] ? now : now.next_month).change(day: options[:days_after]).to_s
+        else
+          @session[:"_#{@id}_shown_at"] = now.to_s
+        end
+      end
+
+      private
+
+      def day_after?
+        now = Time.now
+        @session[:"_next_#{@id}_at"] ||= (now.mday < options[:days_after] ? now.change(day: options[:days_after]) : now).to_s
+        now >= @session[:"_next_#{@id}_at"]
+      end
+
+      def elapsed?
+        shown_at.nil? || Time.parse(shown_at) + interval < Time.now
+      end
+
+      def enabled?
+        !@session[:"_#{@id}_disabled"]
+      end
+
+      def interval
+        options[:interval] ||= 24 * 60 * 60
+      end
+
+      def options
+        TutoManager.tutos[@id]
+      end
+
+      def shown_at
+        @session[:"_#{@id}_shown_at"]
+      end
+    end
+
+    def tuto(id)
+      Tuto.new(id, session)
+    end
+  end
+end
+
+Object.class_eval do
+  include TutoManager::Register
+end
+
+if defined?(ActionController)
+  ActionController::Base.class_eval do
+    include TutoManager::Helpers
+    helper_method :tuto
+  end
+end

data/lib/tuto_man/version.rb

@@ -0,0 +1,3 @@
+module TutoMan
+  VERSION = "0.0.1"
+end

data/spec/tuto_man_spec.rb

@@ -0,0 +1,94 @@
+require 'tuto_man'
+
+describe TutoManager::Helpers do
+  before do
+    @controller_class = Class.new
+    @controller = @controller_class.new
+    @controller_class.send(:include, TutoManager::Helpers)
+    @controller.stub(:session).and_return(session)
+  end
+
+  describe "Interval mode" do
+    before { TutoMan :foo }
+
+    describe "#on?" do
+      subject { @controller.tuto(:foo).on? }
+
+      context "first time" do
+        let(:session){ {} }
+        it { should be_true }
+      end
+
+      context "recently shown" do
+        let(:session){ {} }
+        before { @controller.tuto(:foo).shown }
+        it { should be_false }
+      end
+
+      context "shown long time ago" do
+        let(:session){ {foo_shown_at: 2.days.ago.to_s} }
+        it { should be_true }
+
+        context "turned off" do
+          before { @controller.tuto(:foo).off }
+          it { should be_false }
+        end
+      end
+    end
+  end
+
+  describe "After day of month mode" do
+    before { TutoMan :bar, days_after: 20 }
+
+    describe "#on?" do
+      subject { @controller.tuto(:bar).on? }
+
+      context "on Jan 15" do
+        before { Time.stub(now: Time.new(2013, 1, 15)) }
+
+        context "first time" do
+          let(:session){ {} }
+          it { should be_false }
+        end
+
+        context "second time" do
+          let(:session){ {_next_bar_at: '2013-01-20 00:00:00 +0900'} }
+          it { should be_false }
+        end
+      end
+
+      context "on Jan 25" do
+        before { Time.stub(now: Time.new(2013, 1, 25)) }
+
+        context "first time" do
+          let(:session){ {} }
+          it { should be_true }
+        end
+
+        context "second time" do
+          let(:session){ {_next_bar_at: '2013-02-20 00:00:00 +0900'} }
+          it { should be_false }
+        end
+      end
+    end
+
+    describe "#shown" do
+      let(:session){ {} }
+      before do
+        Time.stub(now: Time.new(2013, 1, mday))
+        @controller.tuto(:bar).shown
+      end
+      subject { session[:_next_bar_at] }
+
+      context "on Jan 15" do
+        let(:mday){ 15 }
+        it { should eq '2013-01-20 00:00:00 +0900' }
+      end
+
+      context "on Jan 25" do
+        let(:mday){ 25 }
+        it { should eq '2013-02-20 00:00:00 +0900' }
+      end
+    end
+  end
+end

data/tuto_man.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tuto_man/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tuto_man"
+  spec.version       = TutoMan::VERSION
+  spec.authors       = ["Hiroki Yoshioka"]
+  spec.email         = ["irohiroki@gmail.com"]
+  spec.summary       = %q{A tutorial view or reminder manager for rails applications.}
+  spec.description   = %q{TutoMan manages diplays of tutorial views or reminders in a rails application.}
+  spec.homepage      = "https://github.com/krayinc/tuto_man"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: tuto_man
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroki Yoshioka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: TutoMan manages diplays of tutorial views or reminders in a rails application.
+email:
+- irohiroki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tuto_man.rb
+- lib/tuto_man/version.rb
+- spec/tuto_man_spec.rb
+- tuto_man.gemspec
+homepage: https://github.com/krayinc/tuto_man
+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.2.0
+signing_key: 
+specification_version: 4
+summary: A tutorial view or reminder manager for rails applications.
+test_files:
+- spec/tuto_man_spec.rb