ettin 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a255e66e3119d91b603833ea3a5b75e3aa1c5dbdd2c20bd8095b816c32ffaa57
-  data.tar.gz: ee132d426757a520adbf9cb89fd74397ac8df28459310ee46783e61bd8052243
+  metadata.gz: 41fed733a48804c578d61f4a59536f3ba63a25bd3cb5595395189333309aba22
+  data.tar.gz: 6fce18aa306ba1415d5d8a723472f30c84e45f9a98ff0ad071545163ae3df76b
 SHA512:
-  metadata.gz: d4af0bf580c3ba169d40c29eeeef5198f4129df173adf8858b3fdc9eb2db101493d2a44860df889473ea56221f161e7c7bd75c35ed9b50532e819c713c27c813
-  data.tar.gz: 4333261bbf858c48859b1eb855c8655ff8842569898495977d2390b1a02ab9d0dcb59414566cce58b002102677df5250f6906b1e82693c8049b8258706069734
+  metadata.gz: 21b8171268a52679f6a6b3e21597b78368c09f7897c505bac79f7430ca6198ba366c6a8bf295c11a38bacb695f23df9ace31012358a74cfdc28529436ac4f951
+  data.tar.gz: 197dc51c977d51908e420b89a47007240df6de55d9b249ad2df6290afb88c8598a4d70d0501decab2299d950eda3db9120df15092da13163b91c939e6f1d659a

data/.rubocop.yml

@@ -1,21 +1,38 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3
   Exclude:
+    - 'lib/ettin/deep_transform.rb'
+    - '.bundle/**/*'
+    - 'vendor/bundle/**/*'
     - '*.gemspec'
+    - 'spec/fixtures/**/*'
 
 Naming/FileName:
   ExpectMatchingDefinition: true
   Exclude:
+    - 'bin/**/*'
+    - 'lib/core_extensions/**/*'
     - 'spec/**/*'
     - 'lib/*/version.rb'
 
+RSpec/FilePath:
+  Exclude:
+    - 'spec/**/*.rb' # rubocop error
+
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
 
+# Enabling this cop can break rescue statements in ruby <= 2.4
+Style/RedundantBegin:
+  Enabled: false
+
 # We disable this cop because we want to use Pathname#/
 # and this cop is not configurable at all.
 Layout/SpaceAroundOperators:
@@ -29,7 +46,7 @@ Style/Alias:
   EnforcedStyle: prefer_alias_method
 
 Metrics/LineLength:
-  Max: 100
+  Max: 90
   AllowHeredoc: true
   AllowURI: true
   URISchemes:
@@ -38,15 +55,16 @@ Metrics/LineLength:
 
 Metrics/BlockLength:
   Exclude:
+    - 'spec/support/**/*.rb'
     - 'spec/**/*_spec.rb'
 
 Layout/ElseAlignment:
   Enabled: false
 
-Layout/FirstParameterIndentation:
+Layout/IndentFirstArgument:
   EnforcedStyle: consistent
 
-Layout/AlignParameters:
+Layout/AlignArguments:
   EnforcedStyle: with_fixed_indentation
 
 Layout/CaseIndentation:
@@ -58,6 +76,10 @@ Layout/ClosingParenthesisIndentation:
 Style/ClassAndModuleChildren:
   EnforcedStyle: nested
 
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
 Style/CommentAnnotation:
   Enabled: false
 
@@ -83,10 +105,10 @@ Style/GuardClause:
 Style/IfUnlessModifier:
   Enabled: false
 
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Layout/AlignHash:
@@ -125,14 +147,13 @@ Layout/SpaceInsideBlockBraces:
 Style/SymbolArray:
   EnforcedStyle: brackets
 
-Lint/BlockAlignment:
+Layout/BlockAlignment:
   EnforcedStyleAlignWith: start_of_block
-  #EnforcedStyleAlignWith: start_of_line
 
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: start_of_line
 
-Lint/DefEndAlignment:
+Layout/DefEndAlignment:
   EnforcedStyleAlignWith: def
 
 Performance/RedundantMerge:
@@ -141,3 +162,63 @@ Performance/RedundantMerge:
 Style/WordArray:
   EnforcedStyle: brackets
 
+Style/RescueModifier:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+# This cop just adds extra work when you want to write an integration test,
+# or test something like a jbuilder view.
+RSpec/DescribeClass:
+  Enabled: false
+
+# Using let! is fine, and can be easier to manage than a before block.
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/BeEql:
+  Enabled: false
+
+RSpec/ExampleWithoutDescription:
+  EnforcedStyle: single_line_only
+
+RSpec/HookArgument:
+  EnforcedStyle: each
+
+RSpec/ImplicitSubject:
+  EnforcedStyle: disallow
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: true
+  Max: 3
+
+# Change this as needed.
+RSpec/NestedGroups:
+  Max: 3
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/EmptyExampleGroup:
+  CustomIncludeMethods:
+    - it_allows
+    - it_disallows
+
+RSpec/ContextWording:
+  Prefixes:
+    - as
+    - when
+    - with
+    - without
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -11,20 +11,12 @@ branches:
     - master
     - develop
 
-env:
-  global:
-    - CC_TEST_REPORTER_ID=dfb947d165289cdfab764c2f143dc0b5097878f4100b5580cca3b06932e04840
-
 before_install: gem install bundler
 
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
 script:
     - bundle exec rspec --order=random
 
-after_script:
-    - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT || true
-
+matrix:
+  include:
+    - rvm: ruby-head
+      script: bundle exec rubocop

data/Gemfile

@@ -7,3 +7,4 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in ettin.gemspec
 gemspec
 
+gem "pry"

data/README.md

@@ -1,8 +1,8 @@
 # Ettin
 
 [![Build Status](https://travis-ci.org/mlibrary/ettin.svg?branch=master)](https://travis-ci.org/mlibrary/ettin)
-[![Maintainability](https://api.codeclimate.com/v1/badges/efd34b151bad7dacb994/maintainability)](https://codeclimate.com/github/mlibrary/ettin/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/efd34b151bad7dacb994/test_coverage)](https://codeclimate.com/github/mlibrary/ettin/test_coverage)
+[![Coverage Status](https://coveralls.io/repos/github/mlibrary/ettin/badge.svg?branch=master)](https://coveralls.io/github/mlibrary/ettin?branch=master)
+[![API Docs](https://img.shields.io/badge/API_docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/github/mlibrary/ettin)
 
 ## Summary
 

data/bin/ettin

@@ -8,21 +8,23 @@ require "optparse"
 
 options = {}
 parser = OptionParser.new do |opts|
-  opts.banner = "Creates the standard, empty config files starting from the given path.\n" \
-    "Usage: ettin STARTPATH"
+  opts.banner = "Creates the standard, empty config files starting from the given " \
+    "path.\nUsage: ettin STARTPATH"
 
-  opts.on("-p", "--path STARTPATH", "The root under which the files will be created.") do |p|
-    options[:start_path] = p
-  end
+  opts.on("-p", "--path STARTPATH",
+    "The root under which the files will be created.") do |p|
+      options[:start_path] = p
+    end
 
   opts.on("-v", "--[no-]verbose", "Print paths created") do |v|
     options[:verbose] = v
   end
 
   options[:compat] = false
-  opts.on("-c", "--[no-]compat", "Create extra config files for compatibility with railsconfig gem.") do |c|
-    options[:compat] = c
-  end
+  opts.on("-c", "--[no-]compat",
+    "Create extra config files for compatibility with railsconfig gem.") do |c|
+      options[:compat] = c
+    end
 
   opts.on("-h", "--help", "Prints this help") do
     puts opts
@@ -45,7 +47,7 @@ files = ["development", "production", "test"]
   .uniq
 
 unless options[:compat]
-  files.reject!{|path| path.dirname.basename.to_s == "environments" }
+  files.reject! {|path| path.dirname.basename.to_s == "environments" }
 end
 
 files.each do |path|
@@ -57,7 +59,7 @@ end
 puts "\nAdding .local.yml files to .gitignore" if options[:verbose]
 `echo "\n# Ignore local configuration files" >> .gitignore`
 files
-  .select{|path| path.basename.to_s.include?("local")}
-  .each{|path| `echo "#{path}" >> .gitignore`}
+  .select {|path| path.basename.to_s.include?("local") }
+  .each {|path| `echo "#{path}" >> .gitignore` }
 
 puts "" if options[:verbose]

data/ettin.gemspec

@@ -24,8 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "deep_merge"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rspec"
 end

data/lib/ettin/method_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Ettin
+
+  # A class for analyzing and manipulating a method's name
+  class MethodName
+    ASSIGN_CHAR = "="
+    BANG_CHAR = "!"
+
+    def initialize(method)
+      @method = method.to_s
+    end
+
+    def to_sym
+      method.to_sym
+    end
+
+    def to_s
+      method
+    end
+
+    def clean
+      @clean ||= if bang? || assignment?
+        method.chop
+      else
+        method
+      end.to_sym
+    end
+
+    def bang?
+      method[-1] == BANG_CHAR
+    end
+
+    def assignment?
+      method[-1] == ASSIGN_CHAR
+    end
+
+    private
+
+    attr_reader :method
+  end
+end

data/lib/ettin/options.rb

@@ -2,6 +2,7 @@
 
 require "deep_merge/rails_compat"
 require "forwardable"
+require "ettin/method_name"
 
 module Ettin
 
@@ -18,37 +19,16 @@ module Ettin
       @hash.default = nil
     end
 
-    def method_missing(method, *args, &block)
-      if handles?(method)
-        if !key?(debang(method))
-          if bang?(method)
-            raise KeyError, "key #{debang(method)} not found"
-          else
-            self[debang(method)]
-          end
-        else
-          self[debang(method)]
-        end
-      else
-        super(method, *args, &block)
-      end
+    def method_missing(method, *args, &block) # rubocop:disable Style/MethodMissingSuper
+      return super(method, *args, &block) unless handles?(method)
 
-      if handles?(method)
-        if bang?(method)
-          handle_bang_method(method)
-        else
-          self[debang(method)]
-        end
-      else
-        super(method, *args, &block)
-      end
-    end
-
-    def handle_bang_method(method)
-      if key?(debang(method))
-        self[debang(method)]
+      method = MethodName.new(method)
+      if method.bang?
+        handle_bang_method(method)
+      elsif method.assignment?
+        handle_assignment_method(method, *args)
       else
-        raise KeyError, "key #{debang(method)} not found"
+        self[method.clean]
       end
     end
 
@@ -66,7 +46,9 @@ module Ettin
     alias_method :has_key?, :key?
 
     def merge(other)
-      new_hash = {}.deeper_merge(hash).deeper_merge!(other.to_h, overwrite_arrays: true)
+      new_hash = {}
+        .deeper_merge(hash)
+        .deeper_merge!(other.to_h, overwrite_arrays: true)
       self.class.new(new_hash)
     end
 
@@ -101,20 +83,20 @@ module Ettin
 
     attr_reader :hash
 
-    def handles?(method)
-      /^[a-zA-Z_0-9]*\!?$/.match(method.to_s)
+    def handle_bang_method(method)
+      if key?(method.clean)
+        self[method.clean]
+      else
+        raise KeyError, "key #{method.clean} not found"
+      end
     end
 
-    def bang?(method)
-      method.to_s[-1] == "!"
+    def handle_assignment_method(method, *args)
+      self[method.clean] = args.first
     end
 
-    def debang(method)
-      if bang?(method)
-        method.to_s.chop.to_sym
-      else
-        method
-      end
+    def handles?(method)
+      /^[a-zA-Z_0-9]*(\!|=)?$/.match(method.to_s)
     end
 
     def convert_key(key)

data/lib/ettin/source.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Ettin
+
+  # Generic interface for data sources containing configuration information.
   class Source
     def self.for(target)
       registry.find {|candidate| candidate.handles?(target) }
@@ -8,7 +10,7 @@ module Ettin
     end
 
     def self.registry
-      @@registry ||= []
+      @@registry ||= [] # rubocop:disable Style/ClassVars
     end
 
     def self.register(candidate)

data/lib/ettin/sources/yaml_source.rb

@@ -21,6 +21,7 @@ module Ettin
 
       def load
         return {} unless File.exist?(path)
+
         begin
           YAML.safe_load(ERB.new(File.read(path)).result) || {}
         rescue Psych::SyntaxError => e

data/lib/ettin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ettin
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ettin
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Bryan Hockey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-performance
+  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: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -119,6 +147,7 @@ files:
 - lib/ettin/config_files.rb
 - lib/ettin/deep_transform.rb
 - lib/ettin/hash_factory.rb
+- lib/ettin/method_name.rb
 - lib/ettin/options.rb
 - lib/ettin/source.rb
 - lib/ettin/sources/hash_source.rb
@@ -144,7 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The best way to add settings in any ruby project.