datetimecomponent 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fbdcce9b7b6a91b8ecdb0aced3287fc39984ba8813c8425714357cd9e40eb1b
+  data.tar.gz: 46dce78fc719870d4fa554e3f6c13f5bda036ad0f84c820648a27c87cf9b2591
+SHA512:
+  metadata.gz: 108b1088b44a1198899d01d961d118fe4b0b3b06b53fa3bb35717d96822efbfc177896b3f009563357ac026ee70d83aedfcd2503a0c9617b9d8ab52a95e7ed89
+  data.tar.gz: 4817c7537f6e965d4791f378bb7afab1aeee500e0284a104a3227f4ac560e6358b9fd4ff6c702ee28f0415f8e108b8016ea4e4523798bc91796440ef6d90079e

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,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in datetimecomponent.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 squarebat
+
+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,39 @@
+# Datetimecomponent
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/datetimecomponent`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'datetimecomponent'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install datetimecomponent
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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]/datetimecomponent.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "datetimecomponent"
+
+# 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/datetimecomponent.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/datetimecomponent/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "datetimecomponent"
+  spec.version       = Datetime::VERSION
+  spec.authors       = ["Khadija Sidhpuri"]
+  spec.email         = ["ksidhpuri@gmail.com"]
+
+  spec.summary       = "a view component to render datetime in several formats"
+  spec.description   = "Rendering datetime in different formats and timezones just got easy"
+  spec.homepage      = "https://rubygems.org/gems/datetimecomponent"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_dependency 'view_component', '~> 2.34'
+  spec.add_runtime_dependency "actionview", ">= 5.0.0"
+  spec.add_runtime_dependency "activesupport", ">= 5.0.0"
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/datetimecomponent/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Datetime
+  VERSION = "0.2.0"
+end

data/lib/datetimecomponent.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "datetimecomponent/version"
+require 'view_component/engine'
+
+module Datetime
+  class Error < StandardError; end
+  class DatetimeComponent < ViewComponent::Base
+    FULL_DATETIME_ARGS = { null: '', short: '%a, %-d %b %y, %H:%M %Z', long: '%A, %-d %B %Y, %-l:%M %P %Z' }.freeze
+    DAY_ARGS = { null: '', numeric: '%-d' }.freeze
+    WEEKDAY_ARGS = { null: '', short: '%a', long: '%A'}.freeze
+    MONTH_ARGS = { null: '', short: '%b', long: '%B', numeric: '%-m' }.freeze
+    YEAR_ARGS = { null: '', short: '%-y', long: '%-Y' }.freeze
+    DISPLAY_TIME_ARGS = { null: '', h12: '%-l:%M', h12meridian: '%-l:%M %P', h24: '%H:%M' }.freeze
+  
+    def initialize(custom_datetime_format: '', full_datetime: :null, date_separator: '/', weekday: :null,
+                   day: :null, month: :null, year: :null, display_time: :null, display_timezone: false,
+                   display_zone_offset: false, time_zone: 'UTC')
+      super
+      @date_separator = date_separator
+      @time_zone = TZInfo::Timezone.get(time_zone)
+      @datetime_format = custom_datetime_format
+      return unless @datetime_format.empty?
+  
+      @format_args = {}
+      @format_args[:full_datetime] = FULL_DATETIME_ARGS[full_datetime]
+      @format_args[:weekday] = WEEKDAY_ARGS[weekday]
+      @format_args[:day] = DAY_ARGS[day]
+      @format_args[:month] = MONTH_ARGS[month]
+      @format_args[:year] = YEAR_ARGS[year]
+      @format_args[:display_time] = DISPLAY_TIME_ARGS[display_time]
+      @format_args[:display_timezone] = display_timezone ? '%Z' : ''
+      @format_args[:zone_offset] = display_zone_offset ? 'UTC %:z' : ''
+      @datetime_format = build_datetime_format
+    end
+  
+    private
+  
+    # rubocop:enable Metrics/ParameterLists
+    def build_datetime_format
+      datetime_format = @format_args[:full_datetime]
+      return "#{datetime_format} #{@format_args[:zone_offset]}" unless datetime_format.empty?
+  
+      datetime_format += @format_args[:weekday]
+      datetime_format += ', ' if !datetime_format.empty? && !@format_args[:day].empty?
+  
+      datetime_format += build_dateformat
+      datetime_format += ', ' if !datetime_format.empty? && !@format_args[:display_time].empty?
+  
+      datetime_format += build_timeformat
+      datetime_format
+    end
+  
+    def build_dateformat
+      date_format = @format_args[:day]
+  
+      unless @format_args[:month].empty?
+        date_format += @format_args[:month] == MONTH_ARGS[:numeric] ? @date_separator : ' '
+        date_format += @format_args[:month]
+      end
+  
+      unless @format_args[:year].empty?
+        date_format += @format_args[:month] == MONTH_ARGS[:numeric] ? @date_separator : ' '
+        date_format += @format_args[:year]
+      end
+      date_format
+    end
+  
+    def build_timeformat
+      time_format = @format_args[:display_time]
+      time_format += ' ' unless @format_args[:display_time].empty?
+      time_format += @format_args[:display_timezone]
+      time_format += ' ' unless @format_args[:display_timezone].empty?
+      time_format += @format_args[:zone_offset]
+      time_format
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: datetimecomponent
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Khadija Sidhpuri
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.34'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Rendering datetime in different formats and timezones just got easy
+email:
+- ksidhpuri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- datetimecomponent.gemspec
+- lib/datetimecomponent.rb
+- lib/datetimecomponent/version.rb
+homepage: https://rubygems.org/gems/datetimecomponent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/datetimecomponent
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: a view component to render datetime in several formats
+test_files: []