lp_rails_util 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 985d27d5f00db98f617194033682006b4b50fa60
+  data.tar.gz: f96fa3d43ba4813b2ba44e44e291a9d2ac4e03de
+SHA512:
+  metadata.gz: ea02caa2d387c58141ca03a40faa9708324c55e1afc6431d0dd7933315ad915bd0460815f7a0202659e0fbfe6c27852eb2204d9c0ecb111323a06d1e95e1d647
+  data.tar.gz: 2dd2c0d8b2bcb8d9447d9ec85d361f1a21c1aa226e85c1666ae92d2affe88504cfb997fb48034866c05b9c76d1bbb6c8eb04f985fd9482c3ea4b861e3ccb83f4

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc
+doc

data/.rspec

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

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+README.md

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    lp_rails_util (1.4.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.3.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lp_rails_util!
+  rspec
+
+BUNDLED WITH
+   1.15.1

data/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Launchpad Lab
+
+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,20 @@
+# Rails Utils
+A utility library for our Rails projects.
+
+## JsonHelper
+Helper methods for Rails JSON API responses.
+
+## ReactHelper
+Helper methods for rendering React components using the `react_on_rails` gem.
+
+## TimezoneHelper
+Helper methods for converting times between timezones.
+
+## Documentation
+To view the documentation locally, run:
++ `yard doc`
++ `yard server`
++ Open `localhost:8808`
+
+## Tests
+Run tests with `bundle exec rspec`.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lp_rails_util"
+
+# 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/lib/rails_util.rb

@@ -0,0 +1,6 @@
+require 'active_support'
+require 'rails_util/util'
+require 'rails_util/json_helper'
+require 'rails_util/react_helper'
+require 'rails_util/timezone_helper'
+require 'rails_util/version'

data/lib/rails_util/json_helper.rb

@@ -0,0 +1,127 @@
+module RailsUtil
+  # `RailsUtil::JsonHelper` contains helper methods for rendering JSON API responses
+  module JsonHelper
+    class MissingSerializerError < StandardError; end
+
+    # Renders JSON object, along with other options
+    # @param [Object] resource `ActiveRecord` resource
+    # @param [Symbol=>[Integer, String, Array]] options the key-value option pairs
+    # @return [Object] json object
+    def json_with(resource, **options)
+      return json_empty(**options) unless resource
+      root_key = resource.class.name.split('::').last.underscore
+
+      return json_error(
+        { root_key => map_base_to__error(resource.errors.messages) },
+        **options
+      ) if errors?(resource)
+
+      return json_success(
+        { root_key => {} },
+        **options
+      ) if destroyed?(resource)
+
+      serialize_json_resource(resource, **options)
+    end
+
+    # Renders array of JSON objects, along with other options, or an empty array
+    # if the array contains no values
+    # @param [Array] resources array of resources
+    # @param [Symbol=>[Integer, String, Array]] options the key-value option pairs
+    # @return [Array] array of json objects
+    def json_collection(resource, **options)
+      return render json: [], **options unless resource.any?
+      json_with(resource, **options)
+    end
+
+    # Renders empty JSON object, along with other options
+    # @param [Symbol=>[Integer, String, Array]] options the key-value option pairs
+    # @return [Object] empty json object
+    def json_empty(**options)
+      render json: {}, **options
+    end
+
+    # Renders JSON error response with `422` status, along with other options
+    # @param [String, Hash] nested_path_or_obj the key-value option pairs
+    # @param [String] message the message to include in the error object
+    # @param [Symbol=>[Integer, String, Array]] options the key-value option pairs
+    # @return [Object] json error object
+    def json_error(nested_path_or_obj, message=nil, **options)
+      error_obj = set_nested_path(nested_path_or_obj, message)
+      render(
+        json: { errors: error_obj },
+        status: :unprocessable_entity,
+        **options
+      )
+    end
+
+    # Renders JSON success response, along with other options
+    # @param [String,Hash] path_or_obj the key-value option pairs
+    # @param [String=nil] message the message to include in the error object
+    # @param [Symbol=>[Integer, String, Array]] options the key-value option pairs
+    # @return [Object] json success object
+    def json_success(path_or_obj, message=nil, **options)
+      render(
+        json: set_nested_path(path_or_obj, message),
+        **options
+      )
+    end
+
+    # Renders serialized JSON resource
+    # @param [Object] resource `ActiveRecord` resource
+    # @param [Symbol=>[Integer, String, Array]] options the key-value option pairs
+    # @return [Object] json resource object
+    # @raise [MissingSerializerError] if the provided resource does not have a serializer
+    def serialize_json_resource(resource, **options)
+      serializer_options = options[:serializer_options] || {}
+      serializable_resource = ActiveModelSerializers::SerializableResource.new(
+        resource,
+        serializer_options.merge(scope: serialization_scope)
+      )
+      raise MissingSerializerError unless serializable_resource.serializer?
+      serialized_obj = serializable_resource.serializer_instance.object
+      type = options[:resource] || serialized_object_type(serialized_obj)
+
+      data = { type: type, attributes: serializable_resource.serializer_instance }
+      data[:additional_data] = options[:additional_data] if options && options[:additional_data]
+
+      render json: { data: data }, **options
+    end
+
+    private
+
+    def set_nested_path(nested_path_or_obj, message)
+      return set_nested(nested_path_or_obj, message) if nested_path_or_obj.is_a? String
+      nested_path_or_obj
+    end
+
+    def map_base_to__error(error_obj)
+      error_obj[:_error] = error_obj.delete(:base) if error_obj.key? :base
+      error_obj
+    end
+
+    def errors?(resource)
+      resource.respond_to?(:errors) && resource.errors.any?
+    end
+
+    def destroyed?(resource)
+      resource.respond_to?(:destroyed?) && resource.destroyed?
+    end
+
+    def set_nested(path, value, obj={})
+      obj.deep_merge(path_to_hash(path, value))
+    end
+
+    def serialized_object_type(obj)
+      is_multiple = obj.try(:length) && obj.length.positive?
+      type = is_multiple ? Util.underscored_class_name(obj.first).pluralize : Util.underscored_class_name(obj)
+      type.split('/').first
+    end
+
+    def path_to_hash(path, value)
+      parts = (path.is_a?(String) ? path.split('.') : path).reverse
+      initial = { parts.shift => value }
+      parts.reduce(initial) { |a, e| { e => a } }
+    end
+  end
+end

data/lib/rails_util/react_helper.rb

@@ -0,0 +1,22 @@
+module RailsUtil
+  # `RailsUtil::ReactHelper` contains wrapper methods for rendering React components using the `react_on_rails` gem
+  module ReactHelper
+    # Helper method for rendering a React component to the DOM
+    # Note: A view file named `component.html.erb` containing the `react_component` view helper is also required by this method
+    # @example Render a component
+    #   # app/controllers/main_controller.rb
+    #   class MainController < ApplicationController
+    #     def app
+    #       render_component 'MainApp', props: {}
+    #     end
+    #   end
+    #
+    #   # app/views/application/component.html.erb
+    #   <%= react_component component, options %>
+    # @param [String] component the name of the React component to render
+    # @param [Hash] options any `props` and other options to pass to the React object
+    def render_component(component, options = {})
+      render 'component', locals: { component: component, options: options }
+    end
+  end
+end

data/lib/rails_util/timezone_helper.rb

@@ -0,0 +1,72 @@
+require 'active_support/time'
+
+module RailsUtil
+  # `RailsUtil::TimezoneHelper` contains helper methods for converting a time between timezones.
+  # Uses `ActiveSupport::TimeZone` `timezone.tzinfo.name` names (e.g., 'America/Chicago') to identify timezones.
+  module TimezoneHelper
+    class << self
+      SECONDS_PER_HOUR = 3600
+
+      # Converts a time between a `from_timezone` and a `to_timezone`
+      # @param [Time, DateTime] time can be a Time or DateTime object, will use the date of this argument if date not provided separately
+      # @param [String] to_timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name` of the desired timezone
+      # @param [String] from_timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name` of the timezone being converted
+      # @param [Symbol=>[Date]] options key-value option pairs, used to provide a separate Date object if a specific date is needed, otherwise the date of the time argument is used
+      # @return DateTime object with the time in the desired `to_timezone`, and a date of either the provided date or time
+      def convert_timezone(time, to_timezone, from_timezone, **options)
+        date = options.fetch(:date, time)
+        utc_time = convert_to_utc(time, from_timezone, date)
+        convert_from_utc(utc_time, to_timezone, date)
+      end
+
+      private
+
+      # Returns the time in the given timezone converted to UTC with the formatted offset
+      # @param [String] from_timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name` of the timezone being converted
+      # @param [Time, DateTime] time can be a Time or DateTime object, will use date of Time object if no date provided
+      # @param [Time, DateTime] date optional parameter to specify a date, otherwise the date of the provided time will be used
+      # @return DateTime object with the time in UTC, and a date of either the provided date or time
+      def convert_to_utc(time, from_timezone, date=nil)
+        date ||= time
+        timezone_with_offset(time, from_timezone, date).utc
+      end
+
+      # Returns the time in UTC converted to the given timezone with the formatted offset
+      # @param [String] to_timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name` of the desired timezone
+      # @param [Time, DateTime] time can be a Time or DateTime object, will use date of Time object if no date provided
+      # @param [Time, DateTime] date optional parameter to specify a date, otherwise the date of the provided time will be used
+      # @return DateTime object with the time in the given timezone, and a date of either the provided date or time
+      def convert_from_utc(time, to_timezone, date=nil)
+        date ||= time
+        time += utc_offset(to_timezone).hours
+        timezone_with_offset(time, to_timezone, date)
+      end
+
+      # Creates a DateTime object with the offset of the given timezone, a time of the time provided, and a date of either the date or time provided
+      # @param [String] timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name` of the desired timezone
+      # @param [Time, DateTime] time can be a Time or DateTime object, will use date of Time object if no date provided
+      # @param [Time, DateTime] date optional parameter to specify a date, otherwise the date of the provided time will be used
+      # @return DateTime object in the given time with an offset of the given timezone
+      def timezone_with_offset(time, timezone, date=nil)
+        date ||= time
+        DateTime.new(date.year, date.month, date.day, time.hour, time.min, 0, format_offset(timezone))
+      end
+
+      # Returns a string representation of the UTC offset for the given timezone
+      # @param [String] timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name`
+      # @return String object of the UTC offset of the given timezone
+      def format_offset(timezone)
+        offset = utc_offset(timezone).to_s
+        offset.insert(1, '0') if utc_offset(timezone).abs < 10
+        offset + ':00'
+      end
+
+      # Returns a fixnum representation of the UTC offset for the given timezone in hours, taking into account whether Daylight Savings Time is in effect
+      # @param [String] timezone the `ActiveSupport::TimeZone` `timezone.tzinfo.name`
+      # @return FixNum object of the UTC offset of the given timezone
+      def utc_offset(timezone)
+        TZInfo::Timezone.get(timezone).current_period.utc_total_offset / SECONDS_PER_HOUR
+      end
+    end
+  end
+end

data/lib/rails_util/util.rb

@@ -0,0 +1,41 @@
+module RailsUtil
+  # `RailsUtil::Util` includes class helper methods for handling nested hashes
+  module Util
+    # Deep merges a nested hash given a path
+    # Does not mutate the original hash
+    # @param [String, Array] path the nested keys
+    # @param [String, Integer, Array] value the value of nested path key
+    # @param [Hash] obj the hash object to merge
+    # @return [Hash] the nested hash
+    def self.set_nested(path, value, obj={})
+      obj.deep_merge(path_to_hash(path, value))
+    end
+
+    # Deep merges a nested hash given a path
+    # Mutates the original hash
+    # @param [String, Array] path the nested keys
+    # @param [String, Integer, Array] value the value of nested path key
+    # @param [Hash] obj the hash object to merge
+    # @return [Hash] the nested hash
+    def self.set_nested!(path, value, obj={})
+      obj.deep_merge!(path_to_hash(path, value))
+    end
+
+    # Creates a nested hash given a path
+    # @param [String, Array] path the nested keys
+    # @param [String, Integer, Array] value the value of nested path key
+    # @return [Hash] the nested hash
+    def self.path_to_hash(path, value)
+      parts = (path.is_a?(String) ? path.split('.') : path).reverse
+      initial = { parts.shift => value }
+      parts.reduce(initial) { |a, e| { e => a } }
+    end
+
+    # Returns the underscored class name of an `ActiveRecord` object
+    # @param [ActiveRecord Object] the `ActiveRecord` object
+    # @return [String] underscored class name
+    def self.underscored_class_name(obj)
+      obj.class.to_s.underscore
+    end
+  end
+end

data/lib/rails_util/version.rb

@@ -0,0 +1,4 @@
+module RailsUtil
+  # Current `RailsUtil` version
+  VERSION = '1.4.0'.freeze
+end

data/lp_rails_util.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_util/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'lp_rails_util'
+  s.version     = RailsUtil::VERSION
+  s.date        = '2017-04-11'
+  s.summary     = 'Utility code for Rails apps'
+  s.description = 'Utility code for Rails apps'
+  s.authors     = ['Dave Corwin']
+  s.email       = 'dave@launchpadlab.com'
+  s.homepage    = 'https://github.com/launchpadlab/rails_util'
+  s.license     = 'None'
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  s.add_development_dependency 'rspec'
+  s.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: lp_rails_util
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Dave Corwin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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'
+description: Utility code for Rails apps
+email: dave@launchpadlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/rails_util.rb
+- lib/rails_util/json_helper.rb
+- lib/rails_util/react_helper.rb
+- lib/rails_util/timezone_helper.rb
+- lib/rails_util/util.rb
+- lib/rails_util/version.rb
+- lp_rails_util.gemspec
+homepage: https://github.com/launchpadlab/rails_util
+licenses:
+- None
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Utility code for Rails apps
+test_files: []
+has_rdoc: