informator 0.0.1

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

@@ -0,0 +1,2 @@
+---
+minimum_score: 6

data/config/metrics/metric_fu.yml

@@ -0,0 +1,15 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+- app
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/reek.yml

@@ -0,0 +1 @@
+---

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 300
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 4
+CyclomaticComplexityMethodCheck:
+  complexity: 8
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 20
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 300
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 5

data/config/metrics/rubocop.yml

@@ -0,0 +1,76 @@
+---
+# settings added by the 'hexx-suit' module
+# output: "tmp/rubocop"
+# format: "html"
+
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RescueModifier:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/config/metrics/saikuro.yml

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  4
+error_cyclo: 6

data/config/metrics/simplecov.yml

@@ -0,0 +1,8 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: # The list of groups to be shown in the coverage report
+  Libraries: "lib/"
+  Application: "app/"

data/config/metrics/yardstick.yml

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

data/informator.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "informator/version"
+
+Gem::Specification.new do |gem|
+
+  gem.name        = "informator"
+  gem.version     = Informator::VERSION.dup
+  gem.author      = "Andrew Kozin"
+  gem.email       = "andrew.kozin@gmail.com"
+  gem.homepage    = "https://github.com/nepalez/informator"
+  gem.summary     = "Implementation of subscribe/publish design pattern"
+  gem.license     = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = Dir["spec/**/*.rb"]
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
+  gem.require_paths    = ["lib"]
+
+  gem.required_ruby_version = "~> 2.1"
+
+  gem.add_development_dependency "hexx-rspec", "~> 0.4"
+
+end # Gem::Specification

data/lib/informator.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require_relative "informator/event"
+require_relative "informator/subscriber"
+require_relative "informator/reporter"
+
+# The module provides subscribe/publish/report features
+#
+module Informator
+
+  # Subscribes the listener for receiving events notifications via callback
+  #
+  # @param [Object] listener
+  #   The object to send events to
+  # @param [#to_sym] callback (:receive)
+  #   The name of the listener method to send events through
+  #
+  # @return [self] itself
+  #
+  def subscribe(listener, callback = :receive)
+    sub = Subscriber.new(listener, callback)
+    __subscribers__ << sub unless __subscribers__.include? sub
+
+    self
+  end
+
+  # @!method remember(type, messages, data)
+  # Builds and stores the event waiting for being published
+  #
+  # @param (see Informator::Event.new)
+  #
+  # @return [self] itself
+  #
+  def remember(*args)
+    __reporter__.remember(*args)
+
+    self
+  end
+
+  # @overload publish(type, messages, data)
+  #   Builds the event and then publishes all unpublished events
+  #
+  #   @param (see #remember)
+  #
+  # @overload publish
+  #   Publishes all unpublished events without adding a new one
+  #
+  # @return [Array<Informator::Event>] list of events having been published
+  #
+  def publish(*args)
+    remember(*args) if args.any?
+    __reporter__.notify __subscribers__
+  end
+
+  # The same as `publish` except for it throws `:published` afterwards
+  #
+  # @overload publish(type, messages, data)
+  #   Builds the event and then publishes all unpublished events
+  #
+  #   @param (see #remember)
+  #
+  # @overload publish
+  #   Publishes all unpublished events without adding a new one
+  #
+  # @raise [UncaughtThrowError, ArgumentError]
+  #   for `:published` events being carried
+  #
+  def publish!(*args)
+    throw :published, publish(*args)
+  end
+
+  private
+
+  def __reporter__
+    @__reporter__ ||= Reporter.new
+  end
+
+  def __subscribers__
+    @__subscribers__ ||= []
+  end
+
+end # module Informator

data/lib/informator/event.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+module Informator
+
+  # Class Event provides an immutable container for hash of some data, to
+  # which a type is attached. It also contains an array of human-readable
+  # messages describing the event.
+  #
+  # The primary goal of events is folding data to be returned and/or sent
+  # between various objects into unified format.
+  #
+  # @example
+  #   event = Event.new :success, "bingo!", foo: :bar
+  #   # => #<Event @type=:success, @messages=["bingo!"], @data={ :foo => :bar }>
+  #   event.frozen?
+  #   # => true
+  #
+  class Event
+
+    include Comparable
+
+    # @!attribute [r] type
+    #
+    # @return [Symbol] the type of the event
+    #
+    attr_reader :type
+
+    # @!attribute [r] data
+    #
+    # @return [Hash] the event-specific data
+    #
+    attr_reader :data
+
+    # @!attribute [r] messages
+    #
+    # @return [Array<String>] human-readable messages, describing the event
+    #
+    attr_reader :messages
+
+    # @!scope class
+    # @!method new(type, messages, data)
+    # Builds the event
+    #
+    # @param [#to_sym] type
+    # @param [#to_s, Array<#to_s>] messages
+    # @param [Hash] data
+    #
+    # @return [Informator::Event]
+
+    # @private
+    def initialize(type, *messages, **data)
+      @type     = type.to_sym
+      @messages = messages.flatten.map(&:to_s)
+      @data     = data
+      freeze
+    end
+
+    # Compares the event to another one by their types and data
+    #
+    # @param [Object] other
+    #
+    # @return [Boolean]
+    #
+    def ==(other)
+      other.is_a?(self.class) && other.value.eql?(value)
+    end
+
+    protected
+
+    # Returns value to compare events by
+    #
+    # @return [Array]
+    #
+    def value
+      [type, data]
+    end
+
+  end # class Event
+
+end # module Informator

data/lib/informator/reporter.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module Informator
+
+  # Builds, collects and publishes events to selected subscribers
+  #
+  # @example
+  #   reporter = Reporter.new
+  #   reporter.events # => []
+  #
+  #   reporter.remember :success
+  #   reporter.events # => [#<Event @type=:success @data={} @messages=[]>]
+  #
+  #   # this will call subscriber.notify for any event
+  #   reporter.notify subscriber
+  #   reporter.events # => []
+  #
+  # @api private
+  #
+  class Reporter
+
+    # @private
+    def initialize
+      @events = []
+      freeze
+    end
+
+    # @!attribute [r] events
+    # @return [Array<Informator::Event>]
+    #   the list of registered events that havent'b been published yet
+    attr_reader :events
+
+    # @!method remember(type, messages, data)
+    # Registers the event to be published to subscribers
+    #
+    # @param (see Informator::Event.new)
+    #
+    # @return [self] itself
+    #
+    def remember(*args)
+      events << Event.new(*args)
+
+      self
+    end
+
+    # Notifies subscribers on events registered since the last notification
+    #
+    # Mutates [#events] by excluding all events having been published.
+    #
+    # @param [Informator::Subscriber, Array<Informator::Subscriber>] subscribers
+    #   the list of subscribers to be notified
+    #
+    # @return [Array<Informator::Event>] the list of published events
+    def notify(*subscribers)
+      events.dup.each { publish subscribers.flatten }
+    end
+
+    private
+
+    def publish(subscribers)
+      event = events.shift
+      subscribers.each { |subscriber| subscriber.notify event }
+    end
+
+  end # class Reporter
+
+end # module Informator