stockpile 1.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9285056e00c41c3c09036585e9a8b2d5b517b27b
-  data.tar.gz: 84202f9f191b3ee26b30ed7deadef9203b6e5b8c
+  metadata.gz: 1653950791d5fd843c349e0e0ff6904b414ae783
+  data.tar.gz: 2d66981b77636ffdcaad743772cfb947ff6cabdb
 SHA512:
-  metadata.gz: d0af27d554f66cd6e22006fdcfa75af45dd83305c5061a7fdf7b222e4836525124a9e6ec941dd9a8d95e743c576bb027f089d52be9b1532e78be2c1def10f47b
-  data.tar.gz: c60a70effa8e3e76b0b764807308db584543dfe61df6d519f4dd7344003db56298bd0c69b52c2ffbdb20aacedbe91ece8f5bf3d11a8980f2d26bc463d4bd01df
+  metadata.gz: d537a5118ab9f6fed1888bcb2f3ba4969962b323436ca6f17f295f62e8c4abfbf7fe4c7803b3b3875535583a1ae909ee4c18f39cd96176a585899cc3e95f7274
+  data.tar.gz: e2187afa754b8224d32648e940c48b7f63f2d1603db0895fb33b0303c78bc95a17ca6d17a76c08ca36569426e624461495aaf4a05478c6fc931250aea0103e40

data/.autotest

@@ -1,27 +1,8 @@
 # -*- ruby -*-
+# frozen-string-literal: true
 
-require "autotest/restart"
+require 'autotest/restart'
 
 Autotest.add_hook :initialize do |at|
-  # .minitest.rb ensures that the gem version of minitest is used.
-  at.testlib = ".minitest.rb"
-  # at.testlib = "minitest/unit"
-  #
-  # at.extra_files << "../some/external/dependency.rb"
-  #
-  # at.libs << ":../some/external"
-  #
-  # at.add_exception "vendor"
-  #
-  # at.add_mapping(/dependency.rb/) do |f, _|
-  #   at.files_matching(/test_.*rb$/)
-  # end
-  #
-  # %w(TestA TestB).each do |klass|
-  #   at.extra_class_map[klass] = "test/test_misc.rb"
-  # end
+  at.testlib = '.minitest.rb'
 end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/.minitest.rb

@@ -1,2 +1,2 @@
-gem "minitest"
-require "minitest/autorun"
+gem 'minitest'
+require 'minitest/autorun'

data/.rubocop.yml

@@ -0,0 +1,212 @@
+---
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'tmp/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# This replaces the old Style/Blocks. The default for this is still stupid
+# (multiline blocks are do/end and single-line blocks are {/}), but it now
+# performs a semantic analysis, allowing for the more nuanced version proposed
+# by Jim Weirich around 2004. If a block is used as part of an assignment or
+# method chaining, prefer {/} delimiters; if not, prefer do/end delimiters. It
+# isn't *quite* that simple in all circumstances, but we can add them to one of
+# three groups: ProceduralMethods (prefer do/end), FunctionalMethods ({/}), and
+# ignored (because it does not matter).
+Style/BlockDelimiters:
+  Enabled: false
+  EnforcedStyle: semantic
+  ProceduralMethods:
+    # Methods that are known to be procedural in nature but look functional from
+    # their usage, e.g.
+    #
+    #   time = Benchmark.realtime do
+    #     foo.bar
+    #   end
+    #
+    # Here, the return value of the block is discarded but the return value of
+    # `Benchmark.realtime` is used.
+    - benchmark
+    - bm
+    - bmbm
+    - create
+    - each_with_object
+    - measure
+    - new
+    - realtime
+    - tap
+    - with_object
+    - assert_raises
+    - solr_search
+    - solr_paginated
+    - all_of
+    - any_of
+  FunctionalMethods:
+    # Methods that are known to be functional in nature but look procedural from
+    # their usage, e.g.
+    #
+    #   let(:foo) { Foo.new }
+    #
+    # Here, the return value of `Foo.new` is used to define a `foo` helper but
+    # doesn't appear to be used from the return value of `let`.
+    - let
+    - let!
+    - subject
+    - watch
+  IgnoredMethods:
+    # Methods that can be either procedural or functional and cannot be
+    # categorised from their usage alone, e.g.
+    #
+    #   foo = lambda do |x|
+    #     puts "Hello, #{x}"
+    #   end
+    #
+    #   foo = lambda do |x|
+    #     x * 100
+    #   end
+    #
+    # Here, it is impossible to tell from the return value of `lambda` whether
+    # the inner block's return value is significant.
+    - lambda
+    - proc
+    - it
+Performance/FixedSize:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/IndentAssignment:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 90
+  Exclude:
+    - test/**/*
+    - Gemfile
+
+Style/MethodDefParentheses:
+  Exclude:
+    - test/**/*
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - Gemfile
+    - .autotest
+    - .simplecov-prelude.rb
+
+Style/RedundantSelf:
+  Exclude:
+    - test/test_helper.rb
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false

data/.simplecov-prelude.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+
+SimpleCov.start do
+  command_name 'Minitest'
+  add_filter '/lib/cartage/backport.rb'
+  add_filter '/test/'
+end
+
+gem 'minitest'

data/.travis.yml

@@ -1,18 +1,17 @@
 ---
+sudo: false
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
+  - 2.3.0
+  - 2.2
+  - 2.1
+  - 2.0
   - ruby-head
-  - jruby-19mode
-  - jruby-head
+  - jruby-9.0
   - rbx-2
 matrix:
   allow_failures:
     - rvm: rbx-2
-    - rvm: jruby-head
     - rvm: ruby-head
 gemfile:
   - Gemfile

data/.workenv

@@ -0,0 +1,5 @@
+#! zsh
+
+--workenv-tab --first
+--workenv-tab --desc autotest autotest
+--workenv-tab --desc documents "fswatch -o *.rdoc lib/**/*.rb| xargs -n1 -I{} rake docs"

data/Code-of-Conduct.md

@@ -0,0 +1,76 @@
+## 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 [INSERT EMAIL ADDRESS]. 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

@@ -3,7 +3,7 @@
 # NOTE: This file is present to keep Travis CI happy. Edits to it will not
 # be accepted.
 
-source "https://rubygems.org/"
+source 'https://rubygems.org/'
 gemspec
 
 # vim: syntax=ruby

data/History.md

@@ -0,0 +1,48 @@
+### 2.0 / 2016-04-04
+
+*   1 major change
+
+    *    Dropped support for Ruby 1.9 families.
+
+*   1 bugfix
+
+    *    Fix [stockpile-redis issue #1][]. Although not reported against
+         Stockpile, this issue was caused by calling #fetch (and #delete)
+         against an OpenStruct options object in any instance of
+         Stockpile::Base.
+
+*   1 governance change
+
+    *    Add a Code of Conduct based on the Contributor's Covenant 1.4.
+
+*   Miscellaneous
+
+    *    Added Rubocop.
+
+### 1.1 / 2015-02-10
+
+* 3 minor enhancements
+
+  * Created a base adapter, Stockpile::Base, that implements the core public
+    interface of a connection manager in a consistent way for argument parsing.
+
+  * Created a memory adapter as an example adapter. (This had previously been
+    a test adapter created in the test environment.)
+
+  * Documented changes to how clients can be specified for Stockpile.new,
+    Stockpile#connect, and Stockpile#connection_for.
+
+* 1 bugfix
+
+  * Fix [issue #2][], where
+    the use of the cache adapter causes the Stockpile cache manager to
+    initialize too early.
+
+### 1.0 / 2015-01-21
+
+* 1 major enhancement
+
+  * Birthday!
+
+[issue #2]: https://github.com/halostatue/stockpile/issues/2
+[stockpile-redis issue #1]: https://github.com/halostatue/stockpile-redis/issues/1

data/Licence.rdoc

@@ -2,7 +2,7 @@
 
 This software is available under an MIT-style licence.
 
-* Copyright 2015 Austin Ziegler
+* Copyright 2015–2016 Austin Ziegler
 
 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