user_time_zones 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01f8f2108c682b94569e141475a14e2caa1b8a2a
-  data.tar.gz: 94e4f6edaec4484699e3fff8669836d04ba986d0
+  metadata.gz: 63c040d850767d25e365889bd61d08a8d294ce2e
+  data.tar.gz: 827e347f78558d703189a9ccea451e4614697aa4
 SHA512:
-  metadata.gz: 469266a364b0b1d944028abadc9bf3d232e1a8c625147a511491848307b3b2b08d5ad1460bd839ccbfcac3574d8914a4edf2d380fd95472ff5d35226072affa5
-  data.tar.gz: bb016157dc0327316976e29c8bc5adfdc4ad0d9c0072f3c11dae6e9ae97ad56ddda4c40af269559d455f3a5740e818264c865490dce04ecf1d677bca3df9463e
+  metadata.gz: 859e1635bf09a51578e24e536ced576fb4bef2191a8fbfcb625d1b421ee00c30975f154bbd0e4588892438206459fd1421c9b9b9b93ac944a0fde0ff0d296c56
+  data.tar.gz: df2f3f787e7f59c62c87402fb7eb59d3a166f8b380edb9022c008bf991eee6f8ab3a7e6220a4d6220f4c38648838e0423174383da550e9c37e89d5296379d089

data/.travis.yml

@@ -1,5 +1,10 @@
+cache: bundler
+
 sudo: false
+
 language: ruby
+
 rvm:
   - 2.3.3
+
 before_install: gem install bundler -v 1.14.6

data/README.md

@@ -1,11 +1,22 @@
 # UserTimeZones
 
-UserTimeZones provides an easyway to work with multiple user time zones.
+UserTimeZones provides an easy way to work with multiple user time zones.
 
-UserTimeZones is intended to be small, simple, and well-tested. A large percentage of applications will require
-support for per-user time zones which this gem can assist with. The solution is simple; you could implement it 
+UserTimeZones is small, simple, and tested. A large percentage of applications will require
+support for per-user time zones; this gem can help. The solution is simple, you could implement it 
 yourself, but this library will let you implement the solution the same way, every time, without having 
-to expend excess effort. 
+to expend much effort.
+
+[![Gem Version](https://badge.fury.io/rb/user_time_zones.svg)](https://badge.fury.io/rb/user_time_zones) ![Build status](https://travis-ci.org/tomichj/user_time_zones.svg?branch=master) ![Code Climate](https://codeclimate.com/github/tomichj/user_time_zones/badges/gpa.svg)
+
+
+## Overview
+
+Your `User` model gets a `time_zone` attribute to record the `ActiveSupport::TimeZone` for each user, and
+methods to set/get the time zone as an offset (in hours) from `UTC`. Every controller action is executed in 
+the context of the user's time zone. And, finally, some javascript will help you initially calculate the 
+user's time zone when they sign up.
+
 
 ## Requirements
 
@@ -15,7 +26,7 @@ to expend excess effort.
 
 ## Install
 
-To get started, add the UserTimeZones gem to your `Gemfile` and run `bundle install` to install it:
+To get started, add the gem to your `Gemfile` and run `bundle install` to install it:
 
 ```ruby
 gem 'user_time_zones'
@@ -36,7 +47,7 @@ The install generator will:
 * Insert `include UserTimeZones::User` into your `User` model.
 * Insert `include UserTimeZones::Controller` into your `ApplicationController`.
 
-You may optionally include the javascript to guess a new user's timezone in your `application.js`:
+Include the javascript to calculate a new user's timezone in your `application.js`:
 ```javascript
 //= require user_time_zones
 ```
@@ -92,15 +103,18 @@ You can allow the user to edit their time zone later on, in user#edit or elsewhe
 
 ### Applying the user's time zone
 
-For each action a user takes, UserTimeZones will set the time zone to a user's `:time_zone` . 
-This is done in `ApplcationController` with an `around_action` that calls `Time.use_zone`.
+The `UserTimeZones::Controller` module provides an `around_action` that wraps each action a user takes, setting
+the time zone to the user's `time_zone` attribute for the duration of the controller action.
+
+`UserTimeZones::Controller` was inserted into your `ApplicationController` by the UserTimeZone's install generator.
+ Any controller that needs time zone support should have `include UserTimeZones::Controller`. 
 
 
 ### The User model and time zones
 
 UserTimeZones gives the user a new attribute, `time_zone`, and new methods `time_zone_offset` and `time_zone_offset=`. 
 The `time_zone` user attribute is the name of a `ActiveSupport::TimeZone`. The offset methods are the offset of 
-the time zone from `UTC`, in hours.
+that time zone from `UTC`, in hours. Setting the `time_zone_offset` to a new value will change the user's `time_zone`.
 
 Example:
 ```ruby
@@ -112,8 +126,34 @@ Example:
 => "Alaska"
 >> user.time_zone_offset
 => -9
+>> user.time_zone_offset = -7
+=> -7
+>> user.time_zone
+=> "Arizona"
 ```
 
+Your user model must `include UserTimeZones::User` into your user model. This is done for you by UserTimeZone's
+install generator.
+
+### Selecting a time zone
+
+Typically a user is allowed to manually select their time zone in a `user#edit` action. Nothing special here,
+just use the Rails form helper time_zone_select. For example:
+```erbruby
+<%= form_for @user do |f| %>
+    <!-- ... -->
+    <%= f.label :time_zone, 'Time Zone' %>
+    <%= f.time_zone_select :time_zone, ActiveSupport::TimeZone.all %>
+    <!-- ... -->
+<% end %>
+```
+
+You can limit your user to U.S. time zones:
+```erbruby
+    <%= f.time_zone_select :time_zone, ActiveSupport::TimeZone.us_zones %>
+```
+
+
 
 ### A summary of do’s and don'ts with time zones
 

data/lib/generators/user_time_zones/install/install_generator.rb

@@ -9,12 +9,19 @@ module UserTimeZones
       include UserTimeZone::Generators::Helpers
 
       source_root File.expand_path('../templates', __FILE__)
+
       class_option :model,
                    optional: true,
                    type: :string,
                    banner: 'model',
                    desc: "Specify the model class name if you will use anything other than 'User'"
 
+      class_option :javascript,
+                   type: :boolean,
+                   aliases: '-j',
+                   default: false,
+                   desc: 'Install javascript "require" into application.js'
+
       def initialize(*)
         super
         assign_names!(model_class_name)
@@ -45,7 +52,12 @@ module UserTimeZones
         )
       end
 
-
+      def inject_javascript
+        javascript = File.join('app', 'assets', 'javascripts', 'application.js')
+        if options.javascript && File.exist?(javascript)
+          append_to_file 'app/assets/javascripts/application.js', '//= require user_time_zones'
+        end
+      end
 
       private
 

data/lib/user_time_zones/version.rb

@@ -1,3 +1,3 @@
 module UserTimeZones
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: user_time_zones
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Justin Tomich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails