sidetiq-timezone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad2cffa7fe055e2e0e43be5633b4fa19db3ed8a2
+  data.tar.gz: 2835f57e2fe7ae718bf3d475045274efc21085b1
+SHA512:
+  metadata.gz: 8b4d3a7f504f1d2850e78fff60c147d57adcdacbb89093f1af27493a66b7c3b11a0c7dc3e2485b77e88d7fe38012d3914c71d858b8a4c0f9c9ed789bd06ab8d0
+  data.tar.gz: f552141ec9f6ed598179e4eb4782690ecf7dd7a43f49d6669fd546b442462602a798c901d16abce10e0d77c6d8871ead0921a949566fb71ed492b5217b122e92

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2014-2015 Akinori MUSHA
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,61 @@
+# Sidetiq::Timezone
+
+This library adds time zone support to Sidetiq.  You can name a time
+zone for Sidetiq to use or just let it honor the value of `Time.zone`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidetiq-timezone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidetiq-timezone
+
+## Usage
+
+If you want to explicitly specify a time zone for the Sidetiq
+scheduler, call `Sidetiq.clock.time_zone=` as follows somewhere in
+your application like `config/initializers/sidetiq.rb` if you are
+using Rails.
+
+```ruby
+Sidetiq.clock.time_zone = ActiveSupport::TimeZone['Tokyo']
+```
+
+Otherwise, it is automatically set to `Time.zone` when the first class
+to include `Sidetiq::Schedulable` is defined.
+
+There is no per-worker time zone support since Sidetiq currently has
+just one shared clock that rules all scheduled workers.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/knu/sidetiq-timezone/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 a new Pull Request
+
+## Author
+
+Copyright (c) 2014-2015 Akinori MUSHA.
+
+Licensed under the 2-clause BSD license.  See `LICENSE.txt` for
+details.
+
+Visit the [GitHub Repository](https://github.com/knu/sidetiq-timezone)
+for the latest information.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidetiq/timezone"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidetiq/timezone.rb

@@ -0,0 +1,15 @@
+# :markup: markdown
+
+require 'sidetiq'
+require 'active_support/time'
+
+module Sidetiq
+  # Adds time zone support to Sidetiq.
+  module Timezone
+  end
+end
+
+require 'sidetiq/timezone/version'
+require 'sidetiq/timezone/clock'
+require 'sidetiq/timezone/schedule'
+require 'sidetiq/timezone/schedulable'

data/lib/sidetiq/timezone/clock.rb

@@ -0,0 +1,38 @@
+# :markup: markdown
+
+module Sidetiq
+  module Timezone
+    # Adds an accessor `time_zone`.
+    module Clock
+      attr_accessor :time_zone
+
+      def time_zone=(time_zone)
+        info "Using the time zone: #{time_zone ? time_zone.name : 'none'}"
+        @time_zone = time_zone
+      end
+
+      def gettime
+        if @time_zone
+          @time_zone.now
+        else
+          super
+        end
+      end
+    end
+  end
+
+  class Clock
+    prepend Timezone::Clock
+
+    ##
+    # :attr_accessor: time_zone
+    #
+    # Time zone for Sidetiq.  If you don't set this, it is
+    # automatically set to `Time.zone` when the first class to include
+    # `Sidetiq::Schedulable` is defined.
+    #
+    # ```ruby
+    # Sidetiq.clock.time_zone = ActiveSupport::TimeZone['Tokyo']
+    # ```
+  end
+end

data/lib/sidetiq/timezone/schedulable.rb

@@ -0,0 +1,29 @@
+# :markup: markdown
+
+module Sidetiq
+  module Timezone
+    module Schedulable
+      # Automatically sets the application time zone for Sidetiq when
+      # a (first) worker is defined.
+      module ClassMethods
+        def included(klass)
+          super
+          Sidetiq.clock.time_zone ||= Time.zone
+        end
+      end
+    end
+  end
+
+  module Schedulable
+    class << self
+      prepend Timezone::Schedulable::ClassMethods
+    end
+
+    module ClassMethods
+      # Returns Sidetiq.clock.time_zone.
+      def time_zone
+        Sidetiq.clock.time_zone
+      end
+    end
+  end
+end

data/lib/sidetiq/timezone/schedule.rb

@@ -0,0 +1,25 @@
+# :markup: markdown
+
+module Sidetiq
+  module Timezone
+    module Schedule
+      # Makes start_time adopt the application time zone.
+      module ClassMethods
+        def start_time
+          start_time = super
+          if time_zone = Sidetiq.clock.time_zone
+            time_zone.local(start_time.year, start_time.month, start_time.day)
+          else
+            start_time
+          end
+        end
+      end
+    end
+  end
+
+  class Schedule
+    class << self
+      prepend Timezone::Schedule::ClassMethods
+    end
+  end
+end

data/lib/sidetiq/timezone/version.rb

@@ -0,0 +1,7 @@
+# :markup: markdown
+
+module Sidetiq
+  module Timezone
+    VERSION = "0.1.0"
+  end
+end

data/sidetiq-timezone.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidetiq/timezone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidetiq-timezone"
+  spec.version       = Sidetiq::Timezone::VERSION
+  spec.authors       = ["Akinori MUSHA"]
+  spec.email         = ["knu@idaemons.org"]
+
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  # end
+
+  spec.summary       = %q{Time zone support for Sidetiq}
+  spec.description   = <<'EOF'
+This library adds time zone support to Sidetiq.
+
+You can name a time zone for Sidetiq to use or just let it honor the
+value of `Time.zone`.
+EOF
+  spec.homepage      = "https://github.com/knu/sidetiq-timezone"
+  spec.license       = "2-clause BSDL"
+
+  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_runtime_dependency "sidetiq", "~> 0.6.0"
+  spec.add_runtime_dependency "activesupport", ">= 0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: sidetiq-timezone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akinori MUSHA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidetiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: |
+  This library adds time zone support to Sidetiq.
+
+  You can name a time zone for Sidetiq to use or just let it honor the
+  value of `Time.zone`.
+email:
+- knu@idaemons.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidetiq/timezone.rb
+- lib/sidetiq/timezone/clock.rb
+- lib/sidetiq/timezone/schedulable.rb
+- lib/sidetiq/timezone/schedule.rb
+- lib/sidetiq/timezone/version.rb
+- sidetiq-timezone.gemspec
+homepage: https://github.com/knu/sidetiq-timezone
+licenses:
+- 2-clause BSDL
+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.3
+signing_key: 
+specification_version: 4
+summary: Time zone support for Sidetiq
+test_files: []
+has_rdoc: