pushyd 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deac6c7be88fd0fe05c8afa55880aa29e6c4212d
-  data.tar.gz: 4f6a4226355bbee4a76bb489867f0b000d3455ed
+  metadata.gz: e5aec80f8d9fb5ae6dea9ded765c0c182cb4df3f
+  data.tar.gz: edd2a2cfebcfe4909f423dbd9df2047cc0022e00
 SHA512:
-  metadata.gz: 646e19080f09c51c448189dbe5743a17a5be869670220ce740dd16d1f11ea49f060e8627ffe7ff8c83f61f21cc8d086ee3795bcdf0fce8594c2b639bc5006ffb
-  data.tar.gz: b707e637e0bd0e27acfd71f32c2b5db5caf146429fc1f3b9802facfe415242f0bc0222d6fb6d6a0f63ded5c9ba86b37736e9944fb2e63eb73df93a09a9c14b8f
+  metadata.gz: 833db2c5b2b39dc40e238d7156b89b8953771014bd1443cc88bfd2a683b1f669d9bfbe29816248e7aeb14b9a8a745f2c526c1709558fea1905f92edaed04d878
+  data.tar.gz: 15ab75984969df568efe8abb3fc6bfa5e65c2ff23a96d47d9453390d3329c7cc4aac21942ec1dc20226d125ce18dfad08fa6343745dd8c9843875aa1e40920cf

data/.rubocop.yml

@@ -0,0 +1,794 @@
+# This is the default configuration file. Enabling and disabling is configured
+# in separate files. This file adds all other parameters apart from Enabled.
+
+inherit_from:
+
+
+# Common configuration.
+AllCops:
+  # Include common Ruby source files.
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/*.opal'
+    - '**/config.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+    - '**/Berksfile'
+    - '**/Cheffile'
+    - '**/Vagabondfile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'DOC/**/*'
+    - '**/actors/*'
+  # Cop names are not displayed in offense messages by default. Change behavior
+  # by overriding DisplayCopNames, or by giving the -D/--display-cop-names
+  # option.
+  DisplayCopNames: false
+  # Style guide URLs are not displayed in offense messages by default. Change
+  # behavior by overriding DisplayStyleGuide, or by giving the
+  # -S/--display-style-guide option.
+  DisplayStyleGuide: false
+  # Additional cops that do not reference a style guide rule may be enabled by
+  # default. Change behavior by overriding StyleGuideCopsOnly, or by giving
+  # the --only-guide-cops option.
+  StyleGuideCopsOnly: false
+
+# Indent private/protected/public as deep as method definitions
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+  SupportedStyles:
+    - outdent
+    - indent
+
+# Align the elements of a hash literal if they span more than one line.
+Style/AlignHash:
+  # Alignment of entries using hash rocket as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   'a' => 2
+  #   'bb' => 3
+  # separator - alignment of hash rockets, keys are right aligned
+  #    'a' => 2
+  #   'bb' => 3
+  # table - left alignment of keys, hash rockets, and values
+  #   'a'  => 2
+  #   'bb' => 3
+  EnforcedHashRocketStyle: key
+  # Alignment of entries using colon as separator. Valid values are:
+  #
+  # key - left alignment of keys
+  #   a: 0
+  #   bb: 1
+  # separator - alignment of colons, keys are right aligned
+  #    a: 0
+  #   bb: 1
+  # table - left alignment of keys and values
+  #   a:  0
+  #   bb: 1
+  EnforcedColonStyle: key
+  # Select whether hashes that are the last argument in a method call should be
+  # inspected? Valid values are:
+  #
+  # always_inspect - Inspect both implicit and explicit hashes.
+  #   Registers an offense for:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offense for:
+  #     function({a: 1,
+  #       b: 2})
+  # always_ignore - Ignore both implicit and explicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_implicit - Ignore only implicit hashes.
+  #   Accepts:
+  #     function(a: 1,
+  #       b: 2)
+  #   Registers an offense for:
+  #     function({a: 1,
+  #       b: 2})
+  # ignore_explicit - Ignore only explicit hashes.
+  #   Accepts:
+  #     function({a: 1,
+  #       b: 2})
+  #   Registers an offense for:
+  #     function(a: 1,
+  #       b: 2)
+  EnforcedLastArgumentHashStyle: always_inspect
+  SupportedLastArgumentHashStyles:
+    - always_inspect
+    - always_ignore
+    - ignore_implicit
+    - ignore_explicit
+
+Style/AlignParameters:
+  # Alignment of parameters in multi-line method calls.
+  #
+  # The `with_first_parameter` style aligns the following lines along the same
+  # column as the first parameter.
+  #
+  #     method_call(a,
+  #                 b)
+  #
+  # The `with_fixed_indentation` style aligns the following lines with one
+  # level of indentation relative to the start of the line with the method call.
+  #
+  #     method_call(a,
+  #       b)
+  EnforcedStyle: with_first_parameter
+  SupportedStyles:
+    - with_first_parameter
+    - with_fixed_indentation
+
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  EnforcedStyle: always
+  SupportedStyles:
+    - always
+    - conditionals
+
+
+# Checks if usage of %() or %Q() matches configuration.
+Style/BarePercentLiterals:
+  EnforcedStyle: bare_percent
+  SupportedStyles:
+    - percent_q
+    - bare_percent
+
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+  SupportedStyles:
+    # The `line_count_based` style enforces braces around single line blocks and
+    # do..end around multi-line blocks.
+    - line_count_based
+    # The `semantic` style enforces braces around functional blocks, where the
+    # primary purpose of the block is to return a value and do..end for
+    # procedural blocks, where the primary purpose of the block is its
+    # side-effects.
+    #
+    # This looks at the usage of a block's method to determine its type (e.g. is
+    # the result of a `map` assigned to a variable or passed to another
+    # method) but exceptions are permitted in the `ProceduralMethods`,
+    # `FunctionalMethods` and `IgnoredMethods` sections below.
+    - 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
+  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
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+  SupportedStyles:
+    # The `braces` style enforces braces around all method parameters that are
+    # hashes.
+    - braces
+    # The `no_braces` style checks that the last parameter doesn't have braces
+    # around it.
+    - no_braces
+    # The `context_dependent` style checks that the last parameter doesn't have
+    # braces around it, but requires braces if the second to last parameter is
+    # also a hash literal.
+    - context_dependent
+
+# Indentation of `when`.
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+Style/ClassAndModuleChildren:
+  # Checks the style of children definitions at classes and modules.
+  #
+  # Basically there are two different styles:
+  #
+  # `nested` - have each child on a separate line
+  #   class Foo
+  #     class Bar
+  #     end
+  #   end
+  #
+  # `compact` - combine definitions as much as possible
+  #   class Foo::Bar
+  #   end
+  #
+  # The compact style is only forced, for classes / modules with one child.
+  EnforcedStyle: nested
+  SupportedStyles:
+    - nested
+    - compact
+
+Style/ClassCheck:
+  EnforcedStyle: is_a?
+  SupportedStyles:
+    - is_a?
+    - kind_of?
+
+# Align with the style guide.
+Style/CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+# Use ` or %x around command literals.
+Style/CommandLiteral:
+  EnforcedStyle: backticks
+  # backticks: Always use backticks.
+  # percent_x: Always use %x.
+  # mixed: Use backticks on single-line commands, and %x on multi-line commands.
+  SupportedStyles:
+    - backticks
+    - percent_x
+    - mixed
+  # If false, the cop will always recommend using %x if one or more backticks
+  # are found in the command string.
+  AllowInnerBackticks: false
+
+# Checks formatting of special comments
+Style/CommentAnnotation:
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+
+# Checks that you have put a copyright in a comment before any code.
+#
+# You can override the default Notice in your .rubocop.yml file.
+#
+# In order to use autocorrect, you must supply a value for the
+# AutocorrectNotice key that matches the regexp Notice.  A blank
+# AutocorrectNotice will cause an error during autocorrect.
+#
+# Autocorrect will add a copyright notice in a comment at the top
+# of the file immediately after any shebang or encoding comments.
+#
+# Example rubocop.yml:
+#
+# Style/Copyright:
+#   Enabled: true
+#   Notice: 'Copyright (\(c\) )?2015 Yahoo! Inc'
+#   AutocorrectNotice: '# Copyright (c) 2015 Yahoo! Inc.'
+#
+Style/Copyright:
+  Notice: '^Copyright (\(c\) )?2[0-9]{3} .+'
+  AutocorrectNotice: ''
+
+# Multi-line method chaining should be done with leading dots.
+Style/DotPosition:
+  EnforcedStyle: leading
+  SupportedStyles:
+    - leading
+    - trailing
+
+# Warn on empty else statements
+# empty - warn only on empty else
+# nil - warn on else with nil in it
+# both - warn on empty else and else with nil in it
+Style/EmptyElse:
+  EnforcedStyle: both
+  SupportedStyles:
+    - empty
+    - nil
+    - both
+
+# Use empty lines between defs.
+Style/EmptyLineBetweenDefs:
+  # If true, this parameter means that single line method definitions don't
+  # need an empty line between them.
+  AllowAdjacentOneLineDefs: false
+
+Style/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+  SupportedStyles:
+    - empty_lines
+    - no_empty_lines
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+  SupportedStyles:
+    - empty_lines
+    - no_empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+  SupportedStyles:
+    - empty_lines
+    - no_empty_lines
+
+# Checks whether the source file has a utf-8 encoding comment or not
+# AutoCorrectEncodingComment must match the regex
+# /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
+Style/Encoding:
+  EnforcedStyle: always
+  SupportedStyles:
+    - when_needed
+    - always
+  AutoCorrectEncodingComment: '# encoding: utf-8'
+
+Style/FileName:
+  # File names listed in AllCops:Include are excluded by default. Add extra
+  # excludes here.
+  Exclude: []
+  Enabled: false
+
+Style/FirstParameterIndentation:
+  EnforcedStyle: special_for_inner_method_call_in_parentheses
+  SupportedStyles:
+    # The first parameter should always be indented one step more than the
+    # preceding line.
+    - consistent
+    # The first parameter should normally be indented one step more than the
+    # preceding line, but if it's a parameter for a method call that is itself
+    # a parameter in a method call, then the inner parameter should be indented
+    # relative to the inner method.
+    - special_for_inner_method_call
+    # Same as special_for_inner_method_call except that the special rule only
+    # applies if the outer method call encloses its arguments in parentheses.
+    - special_for_inner_method_call_in_parentheses
+
+# Checks use of for or each in multiline loops.
+Style/For:
+  EnforcedStyle: each
+  SupportedStyles:
+    - for
+    - each
+
+# Enforce the method used for string formatting.
+Style/FormatString:
+  EnforcedStyle: format
+  SupportedStyles:
+    - format
+    - sprintf
+    - percent
+
+# Built-in global variables are allowed by default.
+Style/GlobalVars:
+  AllowedVariables: ["$queue", "$pool"]
+
+# `MinBodyLength` defines the number of lines of the a body of an if / unless
+# needs to have to trigger this cop
+Style/GuardClause:
+  MinBodyLength: 1
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+  SupportedStyles:
+    - ruby19
+    - ruby19_no_mixed_keys
+    - hash_rockets
+# Force hashes that have a symbol value to use hash rockets
+  UseHashRocketsWithSymbolValues: false
+
+Style/IfUnlessModifier:
+  MaxLineLength: 160
+
+Style/IndentationConsistency:
+  # The difference between `rails` and `normal` is that the `rails` style
+  # prescribes that in classes and modules the `protected` and `private`
+  # modifier keywords shall be indented the same as public methods and that
+  # protected and private members shall be indented one step more than the
+  # modifiers. Other than that, both styles mean that entities on the same
+  # logical depth shall have the same indentation.
+  EnforcedStyle: normal
+  SupportedStyles:
+    - normal
+    - rails
+
+Style/IndentationWidth:
+  # Number of spaces for each indentation level.
+  Width: 2
+
+# Checks the indentation of the first key in a hash literal.
+Style/IndentHash:
+  # The value `special_inside_parentheses` means that hash literals with braces
+  # that have their opening brace on the same line as a surrounding opening
+  # round parenthesis, shall have their first key indented relative to the
+  # first position inside the parenthesis.
+  # The value `consistent` means that the indentation of the first key shall
+  # always be relative to the first position of the line where the opening
+  # brace is.
+  EnforcedStyle: special_inside_parentheses
+  SupportedStyles:
+    - special_inside_parentheses
+    - consistent
+
+Style/LambdaCall:
+  EnforcedStyle: call
+  SupportedStyles:
+    - call
+    - braces
+
+Style/Next:
+  # With `always` all conditions at the end of an iteration needs to be
+  # replaced by next - with `skip_modifier_ifs` the modifier if like this one
+  # are ignored: [1, 2].each { |a| return 'yes' if a == 1 }
+  EnforcedStyle: skip_modifier_ifs
+  # `MinBodyLength` defines the number of lines of the a body of an if / unless
+  # needs to have to trigger this cop
+  MinBodyLength: 3
+  SupportedStyles:
+    - skip_modifier_ifs
+    - always
+
+Style/NonNilCheck:
+  # With `IncludeSemanticChanges` set to `true`, this cop reports offenses for
+  # `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which is
+  # **usually** OK, but might change behavior.
+  #
+  # With `IncludeSemanticChanges` set to `false`, this cop does not report
+  # offenses for `!x.nil?` and does no changes that might change behavior.
+  IncludeSemanticChanges: false
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+  SupportedStyles:
+    - require_parentheses
+    - require_no_parentheses
+
+Style/MethodName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+  SupportedStyles:
+    - aligned
+    - indented
+
+Style/NumericLiterals:
+  MinDigits: 5
+
+# Allow safe assignment in conditions.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+Style/PercentQLiterals:
+  EnforcedStyle: lower_case_q
+  SupportedStyles:
+    - lower_case_q # Use %q when possible, %Q when necessary
+    - upper_case_q # Always use %Q
+
+Style/PredicateName:
+  # Predicate name prefices.
+  NamePrefix:
+    - is_
+    - has_
+    - have_
+  # Predicate name prefices that should be removed.
+  NamePrefixBlacklist:
+    - is_
+    - has_
+    - have_
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+  SupportedStyles:
+    - compact # raise Exception.new(msg)
+    - exploded # raise Exception, msg
+
+Style/RedundantReturn:
+  # When true allows code like `return x, y`.
+  AllowMultipleReturnValues: false
+
+# Use / or %r around regular expressions.
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+  # slashes: Always use slashes.
+  # percent_r: Always use %r.
+  # mixed: Use slashes on single-line regexes, and %r on multi-line regexes.
+  SupportedStyles:
+    - slashes
+    - percent_r
+    - mixed
+  # If false, the cop will always recommend using %r if one or more slashes
+  # are found in the regexp string.
+  AllowInnerSlashes: false
+
+Style/Semicolon:
+  # Allow ; to separate several expressions on the same line.
+  AllowAsExpressionSeparator: false
+
+Style/SignalException:
+  EnforcedStyle: semantic
+  SupportedStyles:
+    - only_raise
+    - only_fail
+    - semantic
+
+Style/SingleLineBlockParams:
+  Methods:
+    - reduce:
+        - a
+        - e
+    - inject:
+        - a
+        - e
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/SpaceAroundOperators:
+  AllowForAlignment:
+    - '='
+    - '=>'
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  SupportedStyles:
+    - space
+    - no_space
+  # Valid values are: space, no_space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: true
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SupportedStyles:
+    - space
+    - no_space
+
+Style/SymbolProc:
+  # A list of method names to be ignored by the check.
+  # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
+  IgnoredMethods:
+    - respond_to
+
+Style/TrailingBlankLines:
+  EnforcedStyle: final_newline
+  SupportedStyles:
+    - final_newline
+    - final_blank_line
+
+Style/TrailingCommaInLiteral:
+  # If EnforcedStyleForMultiline is comma, the cop requires a comma after the
+  # last item of a list, but only for lists where each item is on its own line.
+  # If EnforcedStyleForMultiline is consistent_comma, the cop requires a comma
+  # after the last item of a list, for all lists.
+  EnforcedStyleForMultiline: comma
+  SupportedStyles:
+    - comma
+    - consistent_comma
+    - no_comma
+
+# TrivialAccessors requires exact name matches and doesn't allow
+# predicated methods by default.
+Style/TrivialAccessors:
+  # When set to false the cop will suggest the use of accessor methods
+  # in situations like:
+  #
+  # def name
+  #   @other_name
+  # end
+  #
+  # This way you can uncover "hidden" attributes in your code.
+  ExactNameMatch: true
+  AllowPredicates: false
+  # Allows trivial writers that don't end in an equal sign. e.g.
+  #
+  # def on_exception(action)
+  #   @on_exception=action
+  # end
+  # on_exception :restart
+  #
+  # Commonly used in DSLs
+  AllowDSLWriters: false
+  IgnoreClassMethods: false
+  Whitelist:
+    - to_ary
+    - to_a
+    - to_c
+    - to_enum
+    - to_h
+    - to_hash
+    - to_i
+    - to_int
+    - to_io
+    - to_open
+    - to_path
+    - to_proc
+    - to_r
+    - to_regexp
+    - to_str
+    - to_s
+    - to_sym
+
+Style/VariableName:
+  EnforcedStyle: snake_case
+  SupportedStyles:
+    - snake_case
+    - camelCase
+
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+
+Style/WordArray:
+  MinSize: 0
+  # The regular expression WordRegex decides what is considered a word.
+  WordRegex: !ruby/regexp '/\A[\p{Word}]+\z/'
+
+##################### Metrics ##################################
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 15
+
+Metrics/BlockNesting:
+  Max: 3
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 120
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # contaning a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+##################### Lint ##################################
+
+# Allow safe assignment in conditions.
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+# Align ends correctly.
+Lint/EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (if, while, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  AlignWith: keyword
+  SupportedStyles:
+    - keyword
+    - variable
+  AutoCorrect: false
+
+Lint/DefEndAlignment:
+  # The value `def` means that `end` should be aligned with the def keyword.
+  # The value `start_of_line` means that `end` should be aligned with method
+  # calls like `private`, `public`, etc, if present in front of the `def`
+  # keyword on the same line.
+  AlignWith: start_of_line
+  SupportedStyles:
+    - start_of_line
+    - def
+  AutoCorrect: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pushyd (0.3.0)
+    pushyd (0.3.1)
       bunny
       chamber
       daemons
@@ -14,7 +14,7 @@ GEM
   specs:
     addressable (2.4.0)
     amq-protocol (2.0.1)
-    ast (2.2.0)
+    ast (2.3.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
     bunny (2.3.1)
@@ -68,7 +68,7 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.8.1)
-    terminal-table (1.5.2)
+    terminal-table (1.6.0)
     thor (0.19.1)
     unf (0.1.4)
       unf_ext

data/README.md

@@ -1 +1,59 @@
-# pushyd
+pushyd
+====================================================================================
+
+[![Gem Version](https://badge.fury.io/rb/pushyd.svg)](http://badge.fury.io/rb/pushyd)
+[![Code Climate](https://codeclimate.com/github/bmedici/pushyd/badges/gpa.svg)](https://codeclimate.com/github/bmedici/pushyd)
+[![Test Coverage](https://codeclimate.com/github/bmedici/pushyd/badges/coverage.svg)](https://codeclimate.com/github/bmedici/pushyd/coverage)
+[ ![Codeship](https://codeship.com/projects/72fcb0f0-0fa7-0134-fb73-16f75abdb9e2/status?branch=master)](https://codeship.com/projects/156725)
+
+This is a basic proxy listenning to a RabbitMQ bus, and repeating selected messages in POST requests when matching filters
+
+
+Known bugs
+------------------------------------------------------------------------------------
+
+None at this time
+
+
+Contributing
+------------------------------------------------------------------------------------
+
+Contributions are more than welcome, be it for documentation, features, tests,
+refactoring, you name it. If you are unsure of where to start, the [Code
+Climate](https://codeclimate.com/github/bmedici/pushyd) report will
+provide you with improvement directions. And of course, if in doubt, do not
+hesitate to open an issue. (Please note that this project has adopted a [code
+of conduct](CODE_OF_CONDUCT.md).)
+
+If you want your contribution to adopted in the smoothest and fastest way, don't
+forget to:
+
+* provide sufficient documentation in you commit and pull request
+* add proper testing (we know full grown solid test coverage is still lacking and
+  need to up the game)
+* use the [RuboCop](https://github.com/bbatsov/rubocop) guidelines provided
+  (there are all sorts of editor integration plugins available)
+
+So,
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Code
+  * add proper tests if adding a feature
+  * run the tests using `rake`
+  * check for RuboCop style guide violations
+
+4. Commit your changes
+5. Push to the branch (`git push origin my-new-feature`)
+
+6. Create new Pull Request
+
+
+About
+------------------------------------------------------------------------------------
+
+This project has been initiated and originally written by
+Bruno MEDICI Consultant (http://bmconseil.com/)
+
+
+

data/bin/pushyd

@@ -46,7 +46,7 @@ rescue OptionParser::InvalidOption => e
   abort "EXITING: option parser: #{e.message}"
 rescue PushyDaemon::ConfigParseError => e
   abort "EXITING: ConfigParseError: #{e.message}"
-rescue Exception => e
+rescue StandardError => e
   abort "EXITING: Exception: #{e.message}"
 end
 

data/lib/pushyd/conf.rb

@@ -17,19 +17,19 @@ module PushyDaemon
 
     def self.prepare args = {}
       # Context parameters
-      raise PushyDaemon::ConfigMissingParameter, "missing root" unless (@root = args[:root])
-      raise PushyDaemon::ConfigMissingParameter, "missing env"  unless (@env = args[:env])
+      fail PushyDaemon::ConfigMissingParameter, "missing root" unless (@root = args[:root])
+      fail PushyDaemon::ConfigMissingParameter, "missing env"  unless (@env = args[:env])
 
       # Gemspec parameter
       gemspec_path = "#{args[:root]}/#{args[:gemspec]}.gemspec"
-      raise PushyDaemon::ConfigMissingParameter, "missing gemspec" unless args[:gemspec]
-      raise PushyDaemon::ConfigMissingParameter, "gemspec file not found: #{gemspec_path}" unless File.exist?(gemspec_path)
+      fail PushyDaemon::ConfigMissingParameter, "missing gemspec" unless args[:gemspec]
+      fail PushyDaemon::ConfigMissingParameter, "gemspec file not found: #{gemspec_path}" unless File.exist?(gemspec_path)
 
       # Load Gemspec
       @spec     = Gem::Specification::load gemspec_path
       @name     = @spec.name
       @version  = @spec.version
-      raise PushyDaemon::ConfigMissingParameter, "missing name" unless @name
+      fail PushyDaemon::ConfigMissingParameter, "missing name" unless @name
 
       # Init Chamber (defaults, etc, cmdline)
       @files = ["#{args[:root]}/defaults.yml"]
@@ -46,10 +46,10 @@ module PushyDaemon
       self[:log] = args[:log].to_s if args[:log]
 
     rescue Psych::SyntaxError => e
-      raise PushyDaemon::ConfigParseError, e.message
+      fail PushyDaemon::ConfigParseError, e.message
 
     rescue Exception => e
-      raise PushyDaemon::ConfigParseError, e.message
+      fail PushyDaemon::ConfigParseError, e.message
 
     end
 

data/lib/pushyd/daemon.rb

@@ -11,10 +11,14 @@ module PushyDaemon
       # Create a new shouter
       s = Shouter.new
 
-      # Start infinite loop
+      # Start shout loop
       s.shout
 
-    rescue Errno::EACCES, Exception => e
+      # Backup infinite loop in case shout does nothing
+      loop do
+      end
+
+    rescue Errno::EACCES, StandardError => e
       abort "EXITING #{e.class}: #{e.message}"
     end
 

data/lib/pushyd/endpoint.rb

@@ -1,5 +1,5 @@
 require 'bunny'
-require 'securerandom'
+require "securerandom"
 
 module PushyDaemon
   class EndpointConnexionContext    < StandardError; end
@@ -15,7 +15,7 @@ module PushyDaemon
 
       # Create the logger
       @logger = PushyLogger.new(logfile, LOG_ROTATION)
-      @logger.add Logger::INFO, "starting #{self.class.name.to_s}"
+      @logger.add Logger::INFO, "starting #{self.class.name}"
 
       # Declare we're now logging
       puts "#{self.class} logging to #{logfile}"
@@ -25,7 +25,6 @@ module PushyDaemon
 
     def error message, lines = {}
       @logger.add Logger::ERROR, "#{self.class}: #{message}", lines
-      #raise "ABORT #{self.class}: #{message}"
     end
 
     def info message, lines = {}
@@ -34,7 +33,6 @@ module PushyDaemon
 
     def message params = {}
       # Indenting
-      #indent = " " * (params[:way].length)
       lines = []
 
       # Header
@@ -68,7 +66,7 @@ module PushyDaemon
 
     # Start connexion to RabbitMQ
     def connect_channel busconf
-      raise PushyDaemon::EndpointConnexionContext, "invalid bus host/port" unless (busconf.is_a? Hash) &&
+      fail PushyDaemon::EndpointConnexionContext, "invalid bus host/port" unless (busconf.is_a? Hash) &&
         busconf[:host] && busconf[:port]
 
       info "connecting to #{busconf[:host]} port #{busconf[:port]}"
@@ -83,9 +81,9 @@ module PushyDaemon
       channel = conn.create_channel
 
     rescue Bunny::TCPConnectionFailedForAllHosts, Bunny::AuthenticationFailureError, AMQ::Protocol::EmptyResponseError  => e
-      raise PushyDaemon::EndpointConnectionError, "error connecting (#{e.class})"
-    rescue Exception => e
-      raise PushyDaemon::EndpointConnectionError, "unknow (#{e.inspect})"
+      fail PushyDaemon::EndpointConnectionError, "error connecting (#{e.class})"
+    rescue StandardError => e
+      fail PushyDaemon::EndpointConnectionError, "unknow (#{e.inspect})"
     else
       return channel
     end
@@ -103,8 +101,8 @@ module PushyDaemon
       rule_topic = rule[:topic].to_s
       rule_routes = rule[:routes].to_s.split(' ')
       rule_queue = "#{Conf.name}-#{PROXY_SCOPE}-#{rule[:name]}"
-      raise PushyDaemon::EndpointSubscribeContext, "rule [#{rule_name}] lacking topic" unless rule_topic
-      raise PushyDaemon::EndpointSubscribeContext, "rule [#{rule_name}] lacking routes" if rule_routes.empty?
+      fail PushyDaemon::EndpointSubscribeContext, "rule [#{rule_name}] lacking topic" unless rule_topic
+      fail PushyDaemon::EndpointSubscribeContext, "rule [#{rule_name}] lacking routes" if rule_routes.empty?
 
       # Create queue for this rule (remove it beforehand)
       #conn.create_channel.queue_delete(rule_queue_name)
@@ -130,10 +128,10 @@ module PushyDaemon
       end
 
     rescue Bunny::PreconditionFailed => e
-      raise PushyDaemon::EndpointSubscribeError, "PreconditionFailed: [#{rule_topic}] code(#{e.channel_close.reply_code}) message(#{e.channel_close.reply_text})"
+      fail PushyDaemon::EndpointSubscribeError, "PreconditionFailed: [#{rule_topic}] code(#{e.channel_close.reply_code}) message(#{e.channel_close.reply_text})"
 
-    rescue Exception => e
-      raise PushyDaemon::EndpointSubscribeError, "unhandled (#{e.inspect})"
+    rescue StandardError => e
+      fail PushyDaemon::EndpointSubscribeError, "unhandled (#{e.inspect})"
 
     end
 

data/lib/pushyd/proxy.rb

@@ -98,7 +98,7 @@ module PushyDaemon
       response = RestClient.post relay_url.to_s, JSON.pretty_generate(post_body), :content_type => :json
       info "#{id}: #{response.body}"
 
-      rescue Exception => e
+      rescue StandardError => e
         error "propagate: #{e.message}"
     end
 

data/lib/pushyd/pushy_logger.rb

@@ -7,7 +7,7 @@ class PushyLogger < Logger
     super
 
     # And the formatter
-    self.formatter = proc do |severity, datetime, progname, messages|
+    self.formatter = proc do |severity, datetime, _progname, messages|
       # Build common line prefix
       prefix = "%s %s\t" % [
         datetime.strftime(LOG_FORMAT_TIME),

data/lib/pushyd/shouter.rb

@@ -17,14 +17,11 @@ module PushyDaemon
       super
       @keys = []
 
-      # Start connexion to RabbitMQ and create channel
-      @channel = connect_channel Conf.bus
-      info "channel connected"
-
       # Check config
       config_shout = Conf[:shout]
-      if config_shout.empty? || (!config_shout.is_a? Enumerable)
-        abort "prepare: empty [shout] section"
+      unless config_shout && config_shout.any? && config_shout.is_a?(Enumerable)
+        error "prepare: empty [shout] section"
+        return
       end
 
       # Extract information
@@ -32,35 +29,38 @@ module PushyDaemon
       @topic = config_shout[:topic]
       @period = config_shout[:period] || 0
 
+      # Start connexion to RabbitMQ and create channel
+      @channel = connect_channel Conf.bus
+      info "channel connected"
+
       # Create exchange
-      raise PushyDaemon::EndpointTopicContext unless @topic
+      fail PushyDaemon::EndpointTopicContext unless @topic
       @exchange = @channel.topic(@topic, durable: true, persistent: true)
-      info "initialized with parameters:", {topic: @topic, period: @period, keys: @keys}
+      info "initialized with parameters:", { topic: @topic, period: @period, keys: @keys }
 
     rescue Bunny::TCPConnectionFailedForAllHosts => e
       error "ERROR: cannot connect to RabbitMQ hosts (#{e.inspect})"
     end
 
     def shout
+      return unless @exchange
+
       # Prepare exchange
       loop do
-        if true # shout_exchange
-          random_string = SecureRandom.hex
-          random_key = @keys.sample || "random"
-          channel_shout [:ping, random_key, random_string], {}
-        end
+        random_string = SecureRandom.hex
+        random_key = @keys.sample || "random"
+        channel_shout [:ping, random_key, random_string], {}
         sleep @period
       end
     rescue AMQ::Protocol::EmptyResponseError => e
-      raise PushyDaemon::ShouterResponseError, "#{e.class} (#{e.inspect})"
+      fail PushyDaemon::ShouterResponseError, "#{e.class} (#{e.inspect})"
     rescue Bunny::ChannelAlreadyClosed => e
-      raise PushyDaemon::ShouterChannelClosed, "#{e.class} (#{e.inspect})"
+      fail PushyDaemon::ShouterChannelClosed, "#{e.class} (#{e.inspect})"
     rescue Bunny::PreconditionFailed => e
-      raise PushyDaemon::ShouterPreconditionFailed, "#{e.class} (#{e.inspect})"
-
+      fail PushyDaemon::ShouterPreconditionFailed, "#{e.class} (#{e.inspect})"
     rescue Interrupt => e
       @channel.close
-      raise PushyDaemon::ShouterInterrupted, "#{e.class} (#{e.inspect})"
+      fail PushyDaemon::ShouterInterrupted, "#{e.class} (#{e.inspect})"
     end
 
   private
@@ -69,7 +69,7 @@ module PushyDaemon
       # Prepare headers
       headers = {
         sent_at: DateTime.now.iso8601,
-        sent_by: Conf.name
+        sent_by: Conf.name,
         }
 
       # Prepare exchange_name and routing_key

data/pushyd.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   # Project version
-  spec.version                      = "0.3.0"
+  spec.version                      = "0.3.1"
 
   # Project description
   spec.name                         = "pushyd"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushyd
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bruno MEDICI
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - README.md