rack-time-zone-middleware 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6030c8f5342aa87d294dfef6a8144a3d17997d44
-  data.tar.gz: 7a9e56ab384b56eda9bb02508ff05c8a107eca85
+  metadata.gz: 5597742125cbf05656c5a565c9a47221aa44352a
+  data.tar.gz: 16266cec9861ba54fb12b64105b8887f103948b6
 SHA512:
-  metadata.gz: 895a59efa778fda557e4a23cf84436dd674099109ffdbe6ea96bb3ec67f32b32f935e13d95772ee47eb72e00f6449dfce0905ff2e957656151a572586e4fa039
-  data.tar.gz: d18904e4c9b8b2e623626e8822bd236bba3413ad13f06d9451420b03aef30bd71a7a44f00a9fa77db97a556d6f286f145daece52a876cd2d2239fe5722795cc6
+  metadata.gz: f1cd433ef9be1d7a7b40d62fef42c55448f30f83607587a218ffe47f560f31ccb981b13e0298fe8e4fa9ba7c30cd65c828942eaaad7010d1c8912b987104a11e
+  data.tar.gz: 43e925446255ae98141d3e0eacfcf18592bcf0054b77797ec8dba83799cbd59641e8e28703b1355e5f175876128aae90aa92ec9bedae83cb2c47e846d1266048

data/.gitignore

@@ -9,3 +9,7 @@
 /tmp/
 /.idea
 .ruby-version
+.irb_history
+.byebug_history
+/coverage/
+/test/coverage/

data/Gemfile

@@ -5,3 +5,8 @@ gemspec
 gem 'rack', '~> 1.6'
 gem 'activesupport', '~> 4.0'
 gem 'coveralls', require: false
+
+gem 'pry', platforms: :mri
+gem 'pry-byebug', platforms: :mri
+gem 'minitest-byebug', platforms: :mri
+gem 'byebug', platforms: :mri

data/README.md

@@ -28,6 +28,18 @@ Or install it yourself as:
 
     $ gem install rack-time-zone-middleware
 
+## Logic in detail
+
+1. UI
+    1. Use something like [JsTz](http://pellepim.bitbucket.org/jstz/) to determine users time-zone. 
+    2. Write time-zone name to cookie.
+    3. [AngularJS Example](#angularjs)
+2. Ruby
+    1. Use one of loading ways explained below ([Usage](#usage)).
+    2. Provide cookie `key_name` with options, wich includes detected time-zone.
+    3. Provide enironment `key_name` with options, where you store its value.
+    4. Use `env['key_name']` to access saved value from your application or controller.
+  
 ## Usage
 
 ### Sinatra/Padrino application
@@ -78,16 +90,22 @@ config.middleware.use Rack::TimeZoneMiddleware do |middleware, env|
 end
 ```
 
+In theory you can setup dynamic TimeZones detector(when its hash is managed from your Application, from Admin panel or something),  
+but in most of realizations what i saw, it is overhead.
+
 ### Options
 
 | name  | description |
 |---|---|
-| default_tz | TimeZone name fallback value (default: 'Europe/Moscow') |
-| default_as_tz | `ActiveSupport::TimeZone` key name fallback value (default: 'Moscow') |
-| cookie_key | Cookie key name (default: 'dummy.time_zone') |
-| time_zone_key | Environment key name (default: 'dummy.time_zone') |
+| default_tz | `optional`, TimeZone name fallback value (default: 'Europe/Moscow') |
+| default_as_tz | `optional`, `ActiveSupport::TimeZone` key name fallback value (default: 'Moscow') |
+| cookie_key | `optional`, Cookie key name (default: 'dummy.time_zone') |
+| time_zone_key | `optional`, Environment key name (default: 'dummy.time_zone') |
+| time_zone_map | `optional`, TimeZone `Hash` or `lambda`, like `{'Moscow' => 'Europe/Moscow'}`. If not provided `ActiveSupport` TZInfo map will be tried. |
+
+## AngularJS
 
-## AngularJS TimeZone updater factory example via [JsTz](http://pellepim.bitbucket.org/jstz/)
+TimeZone updater factory example via [JsTz](http://pellepim.bitbucket.org/jstz/)
 
 ```javascript
 web.services.factory('JsTz', ['ipCookie', function(ipCookie) {
@@ -105,7 +123,7 @@ web.services.factory('JsTz', ['ipCookie', function(ipCookie) {
 ## Dependencies:
 
 - [Rack](https://github.com/rack/rack)
-- [ActiveSupport](https://github.com/rails/rails)
+- [ActiveSupport(optional)](https://github.com/rails/rails)
 
 ## Contributing
 

data/lib/rack/time-zone-middleware.rb

@@ -1,5 +1,4 @@
 require 'rack/time-zone-middleware/version'
-require 'active_support/values/time_zone'
 
 module Rack
   class TimeZoneMiddleware
@@ -8,6 +7,8 @@ module Rack
     DEFAULT_KEY          = 'dummy.time_zone'
     DEFAULT_COOKIE_KEY   =  DEFAULT_KEY
 
+    MAP_WARNING = "Please install `activesupport` gem and `require 'active_support/values/time_zone'` or provide custom TimeZone map, as a `Hash` like `{'Moscow' => 'Europe/Moscow'}`"
+
     attr_reader :app, :runner, :options
 
     def initialize(app, opts = {}, &block)
@@ -19,6 +20,8 @@ module Rack
       options[:time_zone_key] = opts.fetch(:time_zone_key, DEFAULT_KEY)
       options[:cookie_key]    = opts.fetch(:cookie_key, DEFAULT_COOKIE_KEY)
 
+      @time_zone_map = opts.fetch(:time_zone_map, nil) || default_time_zone_map
+
       if block_given?
         @runner = block
       else
@@ -31,12 +34,27 @@ module Rack
     end
 
     def find_as_time_zone(name)
-      zone_name, _ = ::ActiveSupport::TimeZone::MAPPING.detect { |_, v| v.eql? name }
+      zone_name, _ = time_zone_map.detect { |_, v| v.eql? name }
       zone_name || options[:default_as_tz]
+    rescue
+      options[:default_as_tz]
     end
 
     private
 
+    def time_zone_map
+      @time_zone_map.is_a?(Proc) ? @time_zone_map.call : @time_zone_map
+    end
+
+    def default_time_zone_map(no_test=true)
+      if no_test && defined?(::ActiveSupport::TimeZone::MAPPING)
+        -> { ::ActiveSupport::TimeZone::MAPPING }
+      else
+        $stderr.puts MAP_WARNING
+        -> { {} }
+      end
+    end
+
     def _call(mw, env)
       request = ::Rack::Request.new(env)
 

data/lib/rack/time-zone-middleware/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class TimeZoneMiddleware
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

data/rack-time-zone-middleware.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.licenses      = ['MIT']
 
-  spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
   spec.add_runtime_dependency 'rack', '>= 1.2.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'activesupport', '>= 4.0.0'
+  spec.add_development_dependency 'bundler',       '~> 1.0'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest', '~> 5.6'
+  spec.add_development_dependency 'minitest',      '~> 5.6'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rack-time-zone-middleware
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alexander Merkulov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
+        version: 4.0.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement