cuckoo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af5894d06280bbaf410a868f21179f886fb5611f
+  data.tar.gz: 0d4da35e5a559b512795ecf792eb41e820f4803b
+SHA512:
+  metadata.gz: 196f7f6c13d1035d14c82774595f28126efebcdd292267b497b3b1149e39b212f9acc56ad597e2d88d268794ead5333855fe7e5ff4111411496561445ed66303
+  data.tar.gz: d8c16ef47f304f68bd58aa00f495ff10bfff435e8eafa4417bd9ea2870ff0a5c32e29364caa0d8e7abde3de07fac9d2141e8314501cd3dd662d640b8383eb468

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop-disables.yml

@@ -0,0 +1,114 @@
+Lint/LiteralInCondition:
+  Enabled: false
+
+# These metrics are all mostly useless
+Metrics/AbcSize:
+  Max: 50
+Metrics/BlockNesting:
+  Max: 4
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/MethodLength:
+  Max: 45
+  Exclude:
+    - bin/cuckoo
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Style/ConstantName:
+  Enabled: false
+
+# Configuration parameters: Exclude.
+#
+# We could re-enable this if it understood that the top level module should
+# *not* be documented in files that are not the first to define it.
+#
+Style/Documentation:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+# ********************************
+# Disagree with these style points
+# ********************************
+
+Style/DotPosition:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/EmptyLines:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+
+# Don't favor modifier style ever.
+Style/IfUnlessModifier:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+
+Style/InfiniteLoop:
+  Enabled: false
+Style/RaiseArgs:
+  EnforcedStyle: compact
+Style/RedundantReturn:
+  Enabled: false
+Style/Alias:
+  Enabled: false
+Style/SignalException:
+  EnforcedStyle: only_raise
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Arguable
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+Style/SpaceInsideBlockBraces:
+  Enabled: false
+
+# Arguable
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingCommaInLiteral:
+  # SupportedStyles:
+  #   - comma
+  #   - no_comma
+  EnforcedStyleForMultiline: comma
+
+# Don't favor %w for arrays of words.
+Style/WordArray:
+  Enabled: false
+
+# Definitely do NOT assign variables within a conditional. Christ.
+Style/ConditionalAssignment:
+  Enabled: false
+
+# ********************************
+
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+# I disagree with this cop for the specific case of
+#   if !foo.empty?
+# because I think it's a shame that ruby has no nonempty? predicate, and it's
+# clearer if the double negative is all on the RHS.
+Style/NegatedIf:
+  Exclude: []
+
+Style/SpecialGlobalVars:
+  Enabled: false

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+inherit_from:
+- .rubocop-disables.yml

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "2.3.0"
+  - "2.4.0"
+  - "2.5.0"
+script:
+  bundle exec rake test
+sudo: false
+
+before_install:
+  - gem update --system
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to Cuckoo should be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org).
+
+## [Unreleased]
+
+## [0.0.1] -- 2019-04-04
+
+- Initial public release
+
+<!-- vim: set tw=79 : -->

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Gem dependencies specified in *.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Andy Brody
+
+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,44 @@
+# Cuckoo
+
+[![Gem Version](https://badge.fury.io/rb/cuckoo.svg)](https://rubygems.org/gems/cuckoo)
+[![Build status](https://travis-ci.org/ab/cuckoo.svg)](https://travis-ci.org/ab/cuckoo)
+[![Code Climate](https://codeclimate.com/github/ab/cuckoo.svg)](https://codeclimate.com/github/ab/cuckoo)
+[![Inline Docs](http://inch-ci.org/github/ab/cuckoo.svg?branch=master)](http://www.rubydoc.info/github/ab/cuckoo/master)
+
+This is a placeholder for Cuckoo, a library implementing distributed cron using
+simple locking in Redis.
+
+See also:
+- Zhong — https://github.com/nickelser/zhong
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cuckoo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cuckoo
+
+## Usage: Command Line
+
+TODO
+
+## Usage: Library
+
+See the [YARD documentation](http://www.rubydoc.info/github/ab/cuckoo/master).
+
+TODO
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+task :default do
+  sh 'rake -T'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+def alias_task(alias_task, original)
+  desc "Alias for rake #{original}"
+  task alias_task, Rake.application[original].arg_names => original
+end
+alias_task(:test, :spec)

data/bin/cuckoo

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/cuckoo'
+
+BaseName = File.basename($0)
+
+def puts_err(message)
+  STDERR.puts(BaseName + ': ' + message)
+end
+
+def parse_args
+  _options = {}
+  optparse = OptionParser.new do |opts|
+    opts.banner = <<-EOM
+usage: #{BaseName} [OPTION]...
+
+Cuckoo CLI placeholder
+
+
+Options:
+    EOM
+
+    opts.on('-h', '--help', 'Display this message', ' ') do
+      STDERR.puts opts, ''
+      exit 0
+    end
+    opts.on('-V', '--version', 'Print version number', ' ') do
+      puts 'cuckoo ' + Cuckoo::VERSION
+      exit 0
+    end
+  end
+
+  begin
+    optparse.parse!
+  rescue OptionParser::InvalidOption => err
+    puts_err(err.message)
+    exit 1
+  end
+
+  raise NotImplementedError
+end
+
+parse_args

data/cuckoo.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cuckoo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cuckoo'
+  spec.version       = Cuckoo::VERSION
+  spec.authors       = ['Andy Brody']
+  spec.email         = ['git@abrody.com']
+  spec.summary       = 'Simple, distributed cron using Redis locks (placeholder)'
+  spec.description   = <<-EOM
+    Cuckoo implements simple, distributed cron using locks in Redis.
+    This is a placeholder, as the functionality does not currently exist.
+
+    See also:
+    - zhong (https://rubygems.org/gems/zhong)
+  EOM
+  spec.homepage      = 'https://github.com/ab/cuckoo'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'yard'
+
+  spec.required_ruby_version = '>= 2.3'
+end

data/lib/cuckoo.rb

@@ -0,0 +1,4 @@
+require_relative 'cuckoo/version'
+
+module Cuckoo
+end

data/lib/cuckoo/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cuckoo
+  # version string
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+require_relative '../lib/cuckoo'
+
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/unit/cuckoo/version_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Cuckoo::VERSION do
+  it 'should have a version' do
+    expect(Cuckoo::VERSION).to match(/\A\d+\.\d+\.\d+(-[a-z0-9]+)?\z/)
+  end
+end

data/spec/unit/cuckoo_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Cuckoo do
+  it 'should exist' do
+    expect(Cuckoo.name).to eq 'Cuckoo'
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: cuckoo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Brody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
+    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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+description: |2
+      Cuckoo implements simple, distributed cron using locks in Redis.
+      This is a placeholder, as the functionality does not currently exist.
+
+      See also:
+      - zhong (https://rubygems.org/gems/zhong)
+email:
+- git@abrody.com
+executables:
+- cuckoo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop-disables.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cuckoo
+- cuckoo.gemspec
+- lib/cuckoo.rb
+- lib/cuckoo/version.rb
+- spec/spec_helper.rb
+- spec/unit/cuckoo/version_spec.rb
+- spec/unit/cuckoo_spec.rb
+homepage: https://github.com/ab/cuckoo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Simple, distributed cron using Redis locks (placeholder)
+test_files:
+- spec/spec_helper.rb
+- spec/unit/cuckoo/version_spec.rb
+- spec/unit/cuckoo_spec.rb