i18n-beginning_of_week 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f45d272464d1dab2a4048b92b0dd65b02117b5d4
+  data.tar.gz: 19fc02014735aaecafab4b14f2f89106d514e9b9
+SHA512:
+  metadata.gz: eeee7d51d1949a6e56815362f10bffd3c7b4f6eb8e95e2dc5287893e94d683c1bc4c5d34a41b6e3dd1a5b713c1faf417ff2628f1bf8400da30eac1a2cd700986
+  data.tar.gz: 34ee76f2ad62bb2ceab7e3fcb566149f051626522fb603cd219f3a57d29a31d90756cdea48a952bd34886ced5d81746f3de1bb87bd131826b654e5da1700d8b8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mark Edmondson
+
+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,83 @@
+# I18n::BeginningOfWeek
+
+Different places use different days of the week for the beginning of the week. Ruby allows a configuration variable to be set that
+will change it but that assumes all users have the same beginning of the week requirement. This gem uses I18n to determine the beginning of the week value based on locale allowing users to have automatic different beginning of week settings.
+
+The locale days of week are taken from [momentjs](https://github.com/moment/moment). Changes and corrections are welcome through pull requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n-beginning_of_week'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n-beginning_of_week
+
+## Usage
+
+### Get the beginning_of_week for a locale
+
+```
+I18n.locale = :en
+I18n.beginning_of_week # => :sunday
+```
+
+OR
+
+```
+I18n.beginning_of_week(:en) # => :sunday
+```
+
+### Set the Ruby configuration variable using the I18n.locale value or passed locale value
+
+```
+I18n.locale = :fr
+Date.beginning_of_week = I18n.beginning_of_week
+Date.beginning_of_week # => :sunday
+```
+
+OR
+
+```
+Date.beginning_of_week = I18n.beginning_of_week(:fr)
+Date.beginning_of_week # => :monday
+```
+
+
+### Run a block with the beginning of week value set using the I18n.locale value or passed locale value
+```
+I18n.locale = :ar
+I18n.in_beginning_of_week do
+  Date.beginning_of_week
+end # => :saturday
+```
+
+OR
+
+```
+I18n.in_beginning_of_week(:ar) do
+  Date.beginning_of_week
+end # => :saturday
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/markedmondson/i18n-beginning_of_week.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "i18n/beginning_of_week"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/i18n-beginning_of_week.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n/beginning_of_week/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n-beginning_of_week"
+  spec.version       = I18n::BeginningOfWeek::VERSION
+  spec.authors       = ["Mark Edmondson"]
+  spec.email         = ["mark@retailzipline.com"]
+
+  spec.summary       = %q{Get the beginning of the week from the current I18n locale.}
+  spec.description   = %q{Different locales use different days for the beginning of the week. This gem allows the I18n locale to determine the beginning of the week day.}
+  spec.homepage      = "https://github.com/markedmondson/i18n-beginning_of_week"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/i18n/beginning_of_week.rb

@@ -0,0 +1,64 @@
+require "i18n/beginning_of_week/version"
+require "i18n"
+require "date"
+require "active_support/core_ext/date/calculations"
+
+module I18n
+  module Locale
+    module BeginningOfWeek
+      LOCALE_DAYS = {
+        'af': :monday, 'ar-LY': :saturday, 'ar-MA': :saturday, 'ar-SA': :saturday, 'ar-TN': :monday, 'ar': :saturday,
+        'az': :monday, 'bg': :monday, 'bn': :sunday, 'bo': :sunday, 'br': :monday, 'bs': :monday, 'ca': :monday,
+        'cs': :monday, 'cv': :monday, 'cy': :monday, 'da': :monday, 'de-at': :monday, 'de': :monday, 'dv': :sunday,
+        'el': :monday, 'en-au': :monday, 'en-ca': :monday, 'en-db': :monday, 'en-ie': :monday, 'en-nz': :monday,
+        'en': :sunday, 'eo': :monday, 'es-do': :monday, 'es': :monday, 'et': :monday, 'eu': :monday, 'fa': :saturday,
+        'fi': :monday, 'fo': :monday, 'fr-ca': :monday, 'fr-ch': :monday, 'fr': :monday, 'fy': :monday, 'gd': :monday,
+        'gl': :monday, 'gom-latn': :monday, 'he': :sunday, 'hi': :sunday, 'hr': :monday, 'hu': :monday, 'hy-am': :monday,
+        'id': :monday, 'is': :monday, 'it': :monday, 'ja': :monday, 'jv': :monday, 'ka': :monday, 'kk': :monday, 'km': :monday,
+        'kn': :sunday, 'ko': :sunday, 'ky': :monday, 'lb': :monday, 'lo': :sunday, 'lt': :monday, 'lv': :monday, 'me': :monday,
+        'mi': :monday, 'mk': :monday, 'mr': :sunday, 'ms-my': :monday, 'ms': :monday, 'my': :monday, 'nb': :monday,
+        'ne': :sunday, 'nl-be': :monday, 'nl': :monday, 'nn': :monday, 'pa-in': :sunday, 'pl': :monday, 'pt-rb': :sunday,
+        'pt': :monday, 'ro': :monday, 'ru': :monday, 'sd': :monday, 'se': :monday,'si': :sunday, 'sk': :monday, 'sl': :monday,
+        'sq': :monday, 'sr-cryl': :monday, 'sr': :monday, 'ss': :monday, 'sv': :monday, 'sw': :monday, 'ta': :sunday,
+        'te': :sunday, 'tet': :monday, 'th': :sunday, 'tl-ph': :monday, 'tlh': :monday, 'tr': :monday, 'tzl': :monday,
+        'tzl-latn': :saturday, 'tzm': :saturday, 'uk': :monday, 'ur': :monday, 'uz-latn': :monday, 'uz': :monday,
+        'vi': :monday, 'yo': :monday, 'zh-cn': :monday, 'zh-hk': :monday, 'zh-tq': :monday
+      }.freeze
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Get the beginning of week symbol based on the locale
+        # @return [Symbol]
+        def beginning_of_week(locale = I18n.locale)
+          LOCALE_DAYS[locale] || Date.beginning_of_week
+        end
+
+        # Run the block in the context of the i18n beginning of the week
+        # @param [Block]
+        def in_beginning_of_week(locale = I18n.locale)
+          original_beginning_of_week = Date.beginning_of_week
+          Date.beginning_of_week = beginning_of_week(locale)
+          yield
+        ensure
+          Date.beginning_of_week = original_beginning_of_week
+        end
+
+        private
+
+        # Gives us {0=>:sunday, 1=>:monday, 2=>:tuesday, 3=>:wednesday, 4=>:thursday, 5=>:friday, 6=>:saturday}
+        # Which is way more useful than Date::DAYS_INTO_WEEK :/
+        # @return [Hash<Integer,Symbol>]
+        def day_names_to_hash
+          Date::DAYNAMES.each_with_object(Hash.new).with_index do |(day, memo), index|
+            memo[index] = day.downcase.to_sym
+          end
+        end
+      end
+    end
+  end
+end
+
+I18n.include I18n::Locale::BeginningOfWeek

data/lib/i18n/beginning_of_week/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module BeginningOfWeek
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: i18n-beginning_of_week
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Edmondson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: 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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Different locales use different days for the beginning of the week. This
+  gem allows the I18n locale to determine the beginning of the week day.
+email:
+- mark@retailzipline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n-beginning_of_week.gemspec
+- lib/i18n/beginning_of_week.rb
+- lib/i18n/beginning_of_week/version.rb
+homepage: https://github.com/markedmondson/i18n-beginning_of_week
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Get the beginning of the week from the current I18n locale.
+test_files: []