okay 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 480936344226fb0983ee94c29f233d6a8b3c1c811e13f58430243b4d4cef27a7
-  data.tar.gz: bd70ea5928905aa0123f45d3edb46ab41cc811c5bc8076a73a975d0ab8e967a1
+  metadata.gz: 771620de5d44a7098a96b5e95672a07582327108f8ebe18a0c7aadbfcaa6272e
+  data.tar.gz: 448f409cce2467dc0ecd9f3e940590c1620c69528fe011305848e3b63fe83c8f
 SHA512:
-  metadata.gz: a8c3331f360a7f716ed90c8d215c260e425a21c5ee29fec75dccc78180028459c6046f5c698a7e9310fc473cfa12b290112aaacf2a30caa313261af6f2745c9f
-  data.tar.gz: c3123c13c16a882d17d655ef928d415fb7531ed657884ce72af709d347a9ab20a5f3d4f3bcb1d6c00b53e363ac766c49a6f304a02d36109824e186674d3a4834
+  metadata.gz: '0678fc09142e31bf1fcee8199fad6121fad65d55f3d6d09cc89e46e6be10f35beaa539534e8ef5be709ae89576825686922d455818f1cd19f2a33f5acf949c38'
+  data.tar.gz: e2c75f5898ffbb543a63bc407df09ccadd7e98ea7dc7dfe29f25f72bf0159ac7df5b54c07a60223ffbd11d2fd5c32491d4fc3fd28abbd537b93e5641b55d736c

data/.github_changelog_generator

@@ -0,0 +1,2 @@
+user=how-is
+project=how_is

data/.rubocop.yml

@@ -0,0 +1,223 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'okay.gemspec'
+    - 'bin/*'
+    - 'examples/*'
+    - '**/*~'
+    - 'spec/capture_warnings.rb'
+
+# Exceptions should inherit from StandardError.
+# (RuboCop default is to inherit from RuntimeError.)
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+Metrics/AbcSize:
+  Max: 17
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+
+# Getting this back to the default of 100 would be nice,
+# but the few cases that exceed it don't seem overly concerning.
+Metrics/ClassLength:
+  Max: 120
+
+# Still try for 80, but we'll allow 110 because there's a not-insignificant
+# number of cases where we have long lines.
+#
+# It may be worth revisiting this in the future and refactoring those lines.
+Metrics/LineLength:
+  Max: 120
+  AllowHeredoc: true
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ParameterLists:
+  Max: 6
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# Most readable form.
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+  # Disable because it wound up conflicting with a lot of things like:
+  # foo('bar',
+  #   baz: 'asdf',
+  #   beep: 'boop')
+  #
+  # I suspect these'll disappear when overarching architectural issues are
+  # addressed.
+  Enabled: false
+
+Layout/AlignParameters:
+  # See Style/AlignedHash.
+  Enabled: false
+
+# This codebase may be English, but some English words contain diacritics.
+Style/AsciiComments:
+  Enabled: false
+
+# Despite the fact that some English words contain diacritics, we want all
+# method names to be writable by people who don't have an easy way to type
+# words with diacritics.
+Style/AsciiIdentifiers:
+  Enabled: true
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# There's more nuance around this than RuboCop seems capable of.
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# Don't force use of Time or Date; DateTime is okay.
+Style/DateTime:
+  Enabled: false
+
+# Unicode is good, mkay?
+Style/Encoding:
+  Enabled: true
+
+Style/RedundantSelf:
+  Enabled: false
+
+# Force Unix line endings.
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+# A lot of the approaches I use for making things readable makes this angry.
+# E.g., formatting multiple consecutive assignments so that the equal signs
+# and values line up.
+#
+# foobar = 'blah'
+# baz    = 'asdf'
+# beep   = 'boop'
+Layout/ExtraSpacing:
+  Enabled: false
+
+#   # bad
+#
+#   format('%<greeting>s', greeting: 'Hello')
+#   format('%s', 'Hello')
+#
+#   # good
+#
+#   format('%{greeting}', greeting: 'Hello')
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# Freeze string literals to future-proof the code.
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+# Mixing hash styles just looks silly.
+# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/HashSyntax
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys
+
+Layout/IndentHash:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/IndentArray:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+# I deplore assignments in conditions and never want them in any codebase
+# I have direct control over.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# Use [] for `%`-literal delimiters (e.g. for %q[]) that RuboCop doesn't define
+# anything for. (E.g., %q[].)
+#
+# The reason I prefer [] instead of () is that most of the time I use
+# `%`-literals is inside of function calls, and using () makes it blend in too
+# much.
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: "[]"
+    '%w': '[]'
+    '%W': '[]'
+
+# `has_key?` and `has_value?` are clearer than `key?` and `value?`.
+Style/PreferredHashMethods:
+  Enabled: true
+  EnforcedStyle: verbose
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Indent method calls relative to the receiver, e.g.:
+#   foo \
+#     .bar \
+#     .baz \
+#     .asdf
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# {'foo' => 'bar'} not { 'foo' => 'bar' }
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+
+# I find "foo > 0" more readable than "foo.positive?" personally.
+Style/NumericPredicate:
+  Enabled: false
+
+# https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/RegexpLiteral
+Style/RegexpLiteral:
+  Enabled: false
+
+# Use double quotes everywhere by default.
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Prefer [:foo, :bar] over %i[foo bar].
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Prefer ["foo", "bar"] over %w[foo bar].
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Require parentheses around complex ternary conditions.
+Style/TernaryParentheses:
+  Enabled: true
+  EnforcedStyle: require_parentheses_when_complex
+
+# Require a comma after the last item in an array or hash if each item is on
+# its own line.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,5 +1,25 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.15.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm:
+      - ruby-head
+
+before_install:
+  - gem install bundler
+
+# See https://bors.tech/documentation/getting-started/
+branches:
+  only:
+    # This is where pull requests from "bors r+" are built.
+    - staging
+    # This is where pull requests from "bors try" are built.
+    - trying
+    # Build pull requests.
+    - master

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in okay.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/lib/okay.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 require "okay/version"
 
+##
+# A collection of classes/modules providing simple implementations of
+# useful things.
 module Okay
   # Your code goes here...
 end

data/lib/okay/default.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require "okay/version"
 
+# :nodoc:
 module Okay
+  # :nodoc:
   module DefaultValue
     def self.nil?
       true

data/lib/okay/graphql.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require "okay/version"
 require "okay/http"
 require "json"
 
 module Okay
+  ##
+  # A simple GraphQL client.
+  #
   # Example usage:
   #
   #     require "okay/graphql"
@@ -21,6 +26,8 @@ module Okay
       end
     end
 
+    ##
+    # Implements the GraphQL DSL.
     class QueryDSL
       def initialize(indent = 0, &query)
         @query = ""
@@ -31,13 +38,13 @@ module Okay
 
       def method_missing(name, *args, **kwargs, &block)
         query_part = @indent_str + name.to_s
-        if args.length > 0 || kwargs.length > 0
+        if !args.empty? || !kwargs.empty?
           query_part += "("
 
           query_args = []
           query_args += args unless args.empty?
-          query_args += kwargs.map { |k,v|
-            [k,v.inspect].join(": ")
+          query_args += kwargs.map { |k, v|
+            [k, v.inspect].join(": ")
           }
           query_part += query_args.join(", ")
 
@@ -58,6 +65,8 @@ module Okay
       end
     end
 
+    ##
+    # A class for submitting GraphQL queries.
     class Query
       def initialize(raw_query = nil, &query)
         @query = raw_query || QueryDSL.new(&query)
@@ -83,12 +92,13 @@ module Okay
         end
 
         data = {
-          "query" => to_s
+          "query" => to_s,
         }.to_json
         Okay::HTTP.post(url, headers: headers, data: data)
       end
 
-    private
+      private
+
       def default_github_headers(token)
         {
           "Accept" => "application/vnd.github.v4.idl",
@@ -103,6 +113,8 @@ module Okay
   end
 end
 
+# :nodoc:
+# rubocop:disable all
 class Object
   def self.const_missing(name)
     # HACK: if const_missing is called inside Okay::GraphQL#initialize,
@@ -122,3 +134,4 @@ class Object
     end
   end
 end
+# rubocop:enable all

data/lib/okay/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "okay/version"
 require "openssl/better_defaults"
 require "net/https"
@@ -5,7 +7,9 @@ require "cacert"
 
 Cacert.set_in_env
 
+# :nodoc:
 module Net
+  # :nodoc:
   class HTTPResponse
     # Returns false if the server encountered an error, true otherwise.
     def okay?
@@ -29,18 +33,18 @@ module Net
     #
     #     Okay::HTTP.get("https://example.org/blah.json").or_raise!.from_json
     def from_json
+      return nil unless okay?
+
       require "json"
 
-      if okay?
-        JSON.parse(body)
-      else
-        nil
-      end
+      JSON.parse(body)
     end
   end
 end
 
 module Okay
+  ##
+  # A wrapper around Net::HTTP, focused on ease of use and flexibility.
   module HTTP
     RedirectLimitError = Class.new(StandardError)
 
@@ -95,7 +99,7 @@ module Okay
 
       options = {
         # If the URI starts with "https://", enable SSL/TLS.
-        use_ssl: (uri.scheme == "https")
+        use_ssl: (uri.scheme == "https"),
       }
 
       # Net::HTTP.start() keeps a connection to the host alive
@@ -106,7 +110,7 @@ module Okay
         request_class = Net::HTTP.const_get(http_method)
 
         # Create the request object, but don't send it.
-        request  = request_class.new(uri)
+        request = request_class.new(uri)
 
         headers.each do |k, v|
           request[k] = v

data/lib/okay/template.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "okay/version"
+require "okay/warning_helpers"
+require "pathname"
+
+module Okay
+  ##
+  # An extremely simple templating engine.
+  #
+  # General usage:
+  #
+  #     template = Okay::Template.new("./templates")
+  #     puts template.apply("some_template.html", {"some_key": "some value"})
+  #     template.directory #=> "./templates"
+  class Template
+    include WarningHelpers
+
+    attr_reader :directory
+
+    ##
+    # Create an Okay::Templates object.
+    #
+    # @param directory [String] Path of the directory containing the templates.
+    def initialize(directory)
+      @directory = directory
+    end
+
+    ##
+    # Apply the template referenced by +template_name+ to +data+.
+    #
+    # @param template_name [String] Name of the template to use,
+    #   relative to +@directory+ (as passed to +#initialize+).
+    # @param data [Hash] Data to apply the template to.
+    #
+    # @return [String] Result of applying the template to +data+.
+    def apply(template_name, data)
+      template_file = Pathname.new(@directory).join(template_name)
+      template = template_file.read
+
+      # Silence warnings while applying the template, since we don't
+      # generally care about unused keys.
+      silence_warnings { Kernel.format(template, data) }
+    end
+  end
+end

data/lib/okay/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Okay
-  VERSION = "8.0.0"
+  VERSION = "9.0.0"
 end

data/lib/okay/warning_helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "okay/version"
+
+module Okay
+  ##
+  # Helper functions for suppressing warnings when we know it's okay.
+  module WarningHelpers
+    def silence_warnings(&block)
+      with_warnings(nil, &block)
+    end
+
+    def with_warnings(flag, &_block)
+      old_verbose = $VERBOSE
+      $VERBOSE = flag
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/okay.gemspec

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # coding: utf-8
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "okay/version"
@@ -24,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "openssl-better_defaults"
   spec.add_runtime_dependency "cacert"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop", "~> 0.49.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okay
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2019-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl-better_defaults
@@ -44,56 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.1
 description: Okay, minimalist implementations of common utilities in Ruby. E.g., HTTP
   fetchers.
 email:
@@ -102,8 +102,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github_changelog_generator"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -118,7 +120,9 @@ files:
 - lib/okay/default.rb
 - lib/okay/graphql.rb
 - lib/okay/http.rb
+- lib/okay/template.rb
 - lib/okay/version.rb
+- lib/okay/warning_helpers.rb
 - okay.gemspec
 homepage: https://github.com/duckinator/okay
 licenses:
@@ -139,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Okay, minimalist implementations of common utilities.