date_by_example 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8467f9d24308479efdaf1fd7a0e1071f3fe37c97c90b36386153f72348ad0c92
+  data.tar.gz: 5013f2e7a18cdcdf3f13ab21b1bb47981850a42934704f72aa9fd91fd3e646d2
+SHA512:
+  metadata.gz: 1560b2ef198d33fed16adfa0efedc8477691b6eb40ebea5cb5d0205e67afdbf9b30aa7537c64c956ad3952f64b96cec5bb4b23d94ef07eb311db133c228ff021
+  data.tar.gz: 0f2472d0cd4db73ed9adf508bbb28e7f6c58edbd083037a828218ff00350cd681483700ba985521faa7ae464b360090b01969f1d0a32ba76e8939d2360d59195

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,149 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - "db/schema.rb" # You can't touch this
+    - ".bundle/**/*" # Auto-generated
+    - "bin/**/*"     # Auto-generated
+    - "vendor/**/*"  # We cannot solve the world's problems
+  TargetRubyVersion: 2.5
+
+Rails:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Style/CaseEquality:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - "spec/**/*"
+    - "lib/tasks/*.rake"
+
+Layout/FirstParameterIndentation:
+  IndentationWidth: 2
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/IndentArray:
+  IndentationWidth: 2
+
+Layout/IndentAssignment:
+  IndentationWidth: 2
+
+Layout/IndentHash:
+  IndentationWidth: 2
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Layout/MultilineHashBraceLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - "spec/**/*" # because let statements use braces for multiline blocks
+
+Layout/BlockEndNewline:
+  Exclude:
+    - "spec/**/*" # because let statements use braces for multiline blocks
+
+Layout/MultilineBlockLayout:
+  Exclude:
+    - "spec/**/*" # because let statements use braces for multiline blocks
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+  Exclude:
+    - "spec/**/*" # because sometimes we use this in expect or then blocks
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/HookArgument:
+  EnforcedStyle: "example"
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at noelrappin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in date_by_example.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    date_by_example (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.57.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.26.0)
+      rubocop (>= 0.53.0)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  date_by_example!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.57)
+  rubocop-rspec (~> 1.25)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Noel Rappin
+
+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,91 @@
+# DateByExample
+
+Provides a Ruby implementation of Go-style date formatting by example
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'date_by_example'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_by_example
+
+## Usage
+
+### Basic usage
+
+This gem adds a `by_example` method to `Date`, `Time`, and `DateTime`.
+
+The argument to this method is the formatted version of a reference date.
+
+For example:
+
+```
+> d = Date.today
+> d.by_example("2006-01-02")   => "2018-06-11"
+
+> t = DateTime.now
+> t.by_example("Jan 02 2006 @ 3:04 pm")  => "Jun 11 2018 @ 3:52 pm"
+
+> t = Time.now
+> t.by_example("Jan 02 2006 @ 3:04 pm")  => "Jun 11 2018 @ 3:53 pm"
+```
+
+The reference date is Jan 2, 2006 at 3:04:05 PM MST, which can be
+remembered as 1 2 3 4 5 6 -7.
+
+I realize that remembering the reference date is not the easy part,
+but I think it's easier than remembering all the strftime format
+strings
+
+### Supported formats
+
+* Year: 2000 and 00 (but not Ruby's %c for the century)
+* Month: January, JANUARY, Jan, JAN, 1, and 01, but not " 1" for space padding
+* Day: 2, 02, 002 (for day of year), Monday, MONDAY, Mon, MON, but not " 2" for space padding
+* Hour: 15, 3, pm, PM
+* Minute: 04
+* Second: 05, 05.000 for milliseconds and 05.000000 and 05.000000000
+* Time Zone: -7000, -07:00, -07:00:00, MST
+
+### Unsupported Formats
+
+This does not support Ruby's week based formats
+
+### Alternate usage
+
+The slow part of using this gem is generating the format string from
+the example, if you want to reuse a format multiple times, you can do so
+by creating and reusing an `ExampleFormatter`
+
+```
+> ef = ExampleFormatter.new("01/02/06")
+> ef.format(Date.today)   => "06/11/18"
+> ef.format(Time.now)     => "06/11/18"
+```
+
+## 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/[USERNAME]/date_by_example. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DateByExample project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/date_by_example/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "date_by_example"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/date_by_example.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "date_by_example/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "date_by_example"
+  spec.version       = DateByExample::VERSION
+  spec.authors       = ["Noel Rappin"]
+  spec.email         = ["noelrappin@gmail.com"]
+
+  spec.summary       = "Go style date formatting by example"
+  spec.description   = "Go style date formatting by example"
+  spec.homepage      = "http://www.github.com/noelrappin/date_by_example"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.57"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.25"
+end

data/lib/date_by_example.rb

@@ -0,0 +1,22 @@
+require "date"
+require "date_by_example/date"
+require "date_by_example/date_time"
+require "date_by_example/time"
+require "date_by_example/version"
+require "date_by_example/example_formatter"
+require "benchmark"
+
+module DateByExample
+  def self.benchmark
+    dt = DateTime.new(2018, 6, 9, 13, 15)
+    Benchmark.bm do |x|
+      x.report do
+        1_000_000.times do
+          ExampleFormatter.new("2 Jan 06 15:04").format(dt)
+        end
+      end
+    end
+
+    # GSUB version is 16.15 seconds
+  end
+end

data/lib/date_by_example/date.rb

@@ -0,0 +1,5 @@
+class Date
+  def by_example(example)
+    ExampleFormatter.new(example).format(self)
+  end
+end

data/lib/date_by_example/date_time.rb

@@ -0,0 +1,5 @@
+class DateTime
+  def by_example(example)
+    ExampleFormatter.new(example).format(self)
+  end
+end

data/lib/date_by_example/example_formatter.rb

@@ -0,0 +1,48 @@
+class ExampleFormatter
+  attr_accessor :reference
+
+  def initialize(reference)
+    @reference = reference
+    @format_string = nil
+  end
+
+  FORMATS = {
+    ".000000000" => ".9N",
+    "-07:00:00" => "%::z",
+    ".000000" => ".%6N",
+    "January" => "%B",
+    "JANUARY" => "%^B",
+    "Monday" => "%A",
+    "MONDAY" => "%^A",
+    "-07:00" => "%:z",
+    "-7000" => "%z",
+    "2006" => "%Y",
+    ".000" => ".%L",
+    "002" => "%j",
+    "Jan" => "%b",
+    "JAN" => "%^b",
+    "Mon" => "%a",
+    "MON" => "%^a",
+    "MST" => "%Z",
+    "15" => "%H",
+    "06" => "%y",
+    "01" => "%m",
+    "02" => "%d",
+    "03" => "%I",
+    "PM" => "%p",
+    "pm" => "%P",
+    "04" => "%M",
+    "05" => "%S",
+    "1" => "%-m",
+    "2" => "%-e"}.freeze
+
+  FORMAT_MATCHER = Regexp.union(FORMATS.keys)
+
+  def format_string
+    @format_string ||= reference.gsub(FORMAT_MATCHER, FORMATS)
+  end
+
+  def format(date)
+    date.strftime(format_string)
+  end
+end

data/lib/date_by_example/time.rb

@@ -0,0 +1,5 @@
+class Time
+  def by_example(example)
+    ExampleFormatter.new(example).format(self)
+  end
+end

data/lib/date_by_example/version.rb

@@ -0,0 +1,3 @@
+module DateByExample
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: date_by_example
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noel Rappin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.57'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+description: Go style date formatting by example
+email:
+- noelrappin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- date_by_example.gemspec
+- lib/date_by_example.rb
+- lib/date_by_example/date.rb
+- lib/date_by_example/date_time.rb
+- lib/date_by_example/example_formatter.rb
+- lib/date_by_example/time.rb
+- lib/date_by_example/version.rb
+homepage: http://www.github.com/noelrappin/date_by_example
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Go style date formatting by example
+test_files: []