ozone 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98d2324e166daa336808e183a8d594f0b18e4cb3
-  data.tar.gz: 2d0b60a51b1d5d5f2a3547a311cb4247476513f2
+  metadata.gz: 803c668d5479c838cb18101b0c29cef1e5737cff
+  data.tar.gz: 3dea45fbad4cbf0e96105f3877219d43b2224bd1
 SHA512:
-  metadata.gz: 1949c0b5bc446edbd87fcc33be20d49c841fcc263864d0f7b187d06a5f93075e7a8a487c325f9c1b142dab6a40db1211b521a91e93f9da3a43d69c593df36fc0
-  data.tar.gz: c00a22953650d7de68a9c1c0f60aaa733b06176824648a2c5dda7582aa91d0bdb266846787d75514b2b93b90a999362ee6b6b0ea0cbfd4f6f7f4ee1416143de2
+  metadata.gz: 7c82342df57042ed2932e909cca6421aefc3384fbe8fffac605b9446cc0068bf8a5012a1b54734440c2214f2a58c9786b339ab67d16730860b40bf51565e5ec7
+  data.tar.gz: 92505c2856f8348b1a2a5960ed8cdd91dba64db920fdfc5d34a0c5452a5fab368072b46d80b02edda668d6b41ec4fecde34fd618910a9f38164613749632a004

data/.gitignore

@@ -1,4 +1,3 @@
-<<<<<<< HEAD
 *.gem
 *.rbc
 /.config
@@ -12,6 +11,7 @@
 /.bundle/
 /.yardoc
 /_yardoc/
+/.idea/
 
 ## Specific to RubyMotion:
 .dat*

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.rubocop.yml

@@ -0,0 +1,107 @@
+# Practice Fusion Rubocop Rules
+AllCops:
+  # Exclude anything that isn't really part of our code.
+  Exclude:
+    - '**/*.gemspec'
+    - '**/Guardfile' # mostly copy/paste
+    - '**/Rakefile'
+    - 'bin/**/*'
+    - 'config/initializers/secret_token.rb' # long tokens
+    - 'db/**/*' # auto-generated
+    - 'spec/rails_helper.rb' # full of solecisms, mostly copy and paste
+    - 'spec/teaspoon_env.rb' # mostly copy and paste
+    - 'spec/vcr_cassettes/**/*'
+    - 'vendor/**/*'
+  DisplayCopNames: true
+  RunRailsCops: true
+  DisplayStyleGuide: true
+
+# This is less volatile if methods change, and there's less busy work lining things up.
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Chain methods with trailing dots.
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# It's not really clearer to replace every if with a return if.
+Style/GuardClause:
+  Enabled: false
+
+# Would enforce do_y if x over if x / do y / end. As with GuardClause above,
+# this enforces code organisation that doesn't necesarily make things clearer.
+IfUnlessModifier:
+  Enabled: false
+
+# Enforce single quotes everywhere except in specs (because there's a lot of
+# human text with apostrophes in spec names, and using double quotes for all
+# of those is more consistent. There shouldn't be much human-readable text in
+# the application code: that is better moved to the locale files.
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  Exclude:
+    - 'spec/**/*'
+
+# Trailing commas are totally fine.
+Style/TrailingComma:
+  Enabled: false
+
+# Just a preference to use %w[] over %w()
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+# We can tolerate a little additional complexity
+# http://c2.com/cgi/wiki?AbcMetric
+Metrics/AbcSize:
+  Max: 24
+  Exclude:
+    - 'spec/**/*'
+
+# We can tolerate a little additional complexity
+# http://c2.com/cgi/wiki?CyclomaticComplexityMetric
+Metrics/CyclomaticComplexity:
+  Max: 8
+  Exclude:
+    - 'spec/**/*'
+
+# We can tolerate a little additional complexity
+# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Metrics/PerceivedComplexity
+Metrics/PerceivedComplexity:
+  Max: 8
+  Exclude:
+    - 'spec/**/*'
+
+# Allow long lines in specs, as it's almost impossible to fit RSpec's
+# expectations into 80 characters.
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Don't worry about long methods in specs.
+Metrics/MethodLength:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+
+# Don't worry about long modules in specs.
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Prefer sensible naming to comments everywhere.
+Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+
+# Would enforce do_y if x over if x / do y / end. As with GuardClause above,
+# this enforces code organisation that doesn't necesarily make things clearer.
+IfUnlessModifier:
+  Enabled: false
+
+# Don't allow assignment in conditionals, ever.
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false

data/README.md

@@ -1,12 +1,5 @@
 # ozone
-Convert time based on offset, with or without dst
-=======
-# Ozone
-
-Given a ruby time, an offset (in minutes), and a boolean whether to observe daylight savings, Ozone provides two things:
-
-1) Convert a ruby time to a string representation, adjusted by offset, and either abiding by or ignoring daylight savings.
-2) Compare with a ruby time to see whether before or after, either abiding by or ignoring daylight savings.
+Time-to-String and String-to-Time operations which operate using time zone offsets (in minutes) and a boolean which indicates whether or not DST is observed.
 
 ## Installation
 
@@ -24,6 +17,29 @@ Or install it yourself as:
 
     $ gem install ozone
 
+## 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/[my-github-username]/ozone/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
+
+
+# Ozone::Time
+
+Given a ruby time (UTC), an offset (in minutes), and a boolean whether to observe daylight savings, Ozone::Time provides two things:
+
+1) Convert a ruby time to a string representation, adjusted by offset, and either abiding by or ignoring daylight savings.
+2) Compare with a ruby time to see whether before or after, either abiding by or ignoring daylight savings.
+
+
 ## Usage
 
 An instance of Ozone::Time can be compared with a ruby time.
@@ -59,33 +75,39 @@ ozone_time = Time.new(
 => true
 ```
 
-This is because during daylight savings, times will be adjusted backwards 1 hour if daylight savings
-is not being observed.
+# Ozone::TimeBuilder
 
-Ozone::Formatter has one method -- call -- which takes a time, offset (from utc, in minutes), whether to use daylight savings, and a [time format](http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime). Default format is YYYY-MM-DD HH:MM.
+Given a datetime string, an offset (in minutes), and a boolean whether to observe daylight savings, Ozone::TimeBuilder builds a ruby time object (UTC). The TimeBuilder serves as an inverse to Ozone::Time which given a ruby time, can generate a string representation of that time.
 
-```ruby
-> Ozone::Formatter.call(time: t, offset: -480, observes_dst: true)
-=> "2014/07/17 17:30"
+## Usage
 
-> Ozone::Formatter.call(time: t, offset: -480, observes_dst: false)
-=> "2014/07/17 16:30"
+`TimeBuilder` accepts four String formats as input to the `from_string` method:
+ - YYYY/MM/DD HH:MM
+ - YYYY/MM/DDTHH:MM
+ - YYYY-MM-DD HH:MM
+ - YYY-MM-DDTHH:MM
+ 
+```ruby
+> builder = Ozone::TimeBuilder.new
+#<Ozone::TimeBuilder:0x007fff4c6e9f30 @observes_dst=nil, @offset=nil, @time_str=nil>
+> time = builder.from_string("2015-11-15 09:00").with_offset(-480).with_dst(false).build
+=> 2015-11-15 08:00:00 UTC
 ```
 
-This functionality can also be accessed via the Ozone::Time#strftime method.
+# Ozone::Formatter
 
-### NOTE: Since all operations are executing in UTC time, the time zone in the format string will *always* be UTC
+Takes a time, offset (from utc, in minutes), whether to use daylight savings, and a [time format](http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime). Default format is YYYY-MM-DD HH:MM.
 
-## Development
+## Usage
+Since all operations are executing in UTC time, the time zone in the format string will *always* be UTC. 
+This functionality can also be accessed via the Ozone::Time#strftime method.
 
-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.
+```ruby
+> Ozone::Formatter.call(time: t, offset: -480, observes_dst: true)
+=> "2014/07/17 17:30"
 
-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).
+> Ozone::Formatter.call(time: t, offset: -480, observes_dst: false)
+=> "2014/07/17 16:30"
+```
 
-## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/ozone/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

data/lib/ozone.rb

@@ -1,5 +1,4 @@
 require 'ozone/version'
-
 require 'active_support/time'
 
 module Ozone
@@ -18,8 +17,8 @@ module Ozone
       @time = time
     end
 
-    def <=>(time_with_zone)
-      adjusted_time <=> to_ozone_time(time_with_zone).adjusted_time
+    def <=>(other)
+      adjusted_time <=> to_ozone_time(other).adjusted_time
     end
 
     def before?(time_with_zone)

data/lib/ozone/version.rb

@@ -1,3 +1,3 @@
 module Ozone
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/time_builder.rb

@@ -0,0 +1,80 @@
+require 'ozone/version'
+require 'active_support/time'
+
+module Ozone
+  class TimeBuilder
+    # Valid formats:
+    # YYYY/MM/DD 00:00,YYYY/MM/DDT00:00, YYYY-MM-DD 00:00, YYYY-MM-DDT00:00
+    DATETIME_FORMAT = %r[(\d{4}[/-]\d{2}[/-]\d{2})[ T](\d{2}:\d{2})]
+
+    def from_string(time_str)
+      @time_str = time_str
+      self
+    end
+
+    def with_offset(offset)
+      @offset = offset
+      self
+    end
+
+    def with_dst(observes_dst)
+      @observes_dst = observes_dst
+      self
+    end
+
+    def build
+      fail StandardError, 'from_string() must be supplied a non-nil datetime string' unless @time_str.is_a?(String)
+      fail StandardError, 'from_string() argument should match YYYY/MM/DD HH:MM' unless DATETIME_FORMAT.match(@time_str)
+      fail StandardError, 'with_offset() must be supplied a number' unless @offset.is_a?(Numeric)
+      fail StandardError, 'with_dst() must be supplied a boolean' if @observes_dst.nil?
+      calculate_utc_time
+    end
+
+    private
+
+    PST = ActiveSupport::TimeZone['Pacific Time (US & Canada)']
+
+    def calculate_utc_time
+      date = DATETIME_FORMAT.match(@time_str)[1]
+      time = DATETIME_FORMAT.match(@time_str)[2]
+
+      # Build UTC time and add/subtract minutes to avoid timezone assumptions and automatic conversions
+      # Apply offsets manually based on @offset and whether or not DST is in effect in a zone known to observe
+      # DST during the specified date/time
+      utc = ::Time.parse("#{date}T#{time}+0000").utc
+
+      if during_dst(date, time) && @observes_dst
+        utc -= 60.minutes
+      end
+
+      if @offset > 0
+        utc + @offset.minutes
+      else
+        utc - @offset.minutes
+      end
+    end
+
+    def during_dst(date, time)
+      pst_time = format '%sT%s-0800', date, time
+      during_dst_pst = ::Time.parse(pst_time).in_time_zone(PST).dst?
+
+      pdt_time = format '%%sT%s-0700', date, time
+      during_dst_pdt = ::Time.parse(pdt_time).in_time_zone(PST).dst?
+
+      # If during_dst_pdt is false and during_dst_pst is true, the time does not exist (hour skipped).
+      if !during_dst_pdt && during_dst_pst
+        fail StandardError 'The time specified occurs during a daylight savings time change and does not exist.'
+      end
+
+      # Both are true:
+      #   The time is during DST (during_dst_pdt is true)
+      # Both are false:
+      #   The time is not during DST (during_dst_pdt is false)
+      # during_dst_pdt is true, during_dst_pst if false:
+      #   The time exists twice as it occurs during a shift back to standard time. In that case, assuming the earlier
+      #   point in time (the one during DST) is acceptable.
+      # Therefore, it is safe to return only the value of during_dst_pdt
+      during_dst_pdt
+    end
+  end
+end

data/ozone.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ozone
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Hubert Huang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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:
 - hubert77@gmail.com
@@ -88,7 +116,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pryrc"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -99,6 +129,7 @@ files:
 - bin/setup
 - lib/ozone.rb
 - lib/ozone/version.rb
+- lib/time_builder.rb
 - ozone.gemspec
 homepage: https://github.com/practicefusion/ozone
 licenses: []