stenotype 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714f7d5fce3afe07cb1f49653fc44410ca0570086a310c8aead9b88229981f08
-  data.tar.gz: 7f69e3448a22a9d1094dbab6a783e206ac36a5c22c1eb10db3f25180ce07d167
+  metadata.gz: cad5a62bd56d635becd56bf9bae4d6421879d29952473fd507ae60885ea4723e
+  data.tar.gz: 0b2d65ef6e1f9a84bd369d908f4133f3787156fcc5a6b46a194b4193fa735411
 SHA512:
-  metadata.gz: 5ac72dfb39d13e86dfee3617cbef85e06dec175541af1ec681298b74c970f0ef54f4e48a434b305778bc49c219604b6d3eeab3d444a9a670a4db8873ad7a0c94
-  data.tar.gz: 399afa50ff49b2b6b163a07345064193f3bdc18cb20719adb55b1ace92b6cafcedf3128f430df033e597836524138bce7f82134671378f113786e7e1f3948fe3
+  metadata.gz: c025894e106d650dcfe1bab82cf878b89a561eaae8a7eb23246a8d01a34800460a17734f55da518602d504a554b41648f6039d3174b2747d093dba8fbfbb0f26
+  data.tar.gz: 790e1a50a3fabff8db4c62017a556532b8acf3f1df6a330b91dfafba0e1af1701335f8463688fb8d201b75420542fd6cbba054939d33cd80e400e87b07100ed3

data/.rubocop.yml

@@ -2,5 +2,6 @@ inherit_gem:
   spicerack-styleguide:
     - rubocop.yml
 
-AllCops:
-  TargetRubyVersion: 2.6
+# Disabled since ApplicationJob is only defined in a real application
+Rails/ApplicationJob:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+*Release Date*: 2019/11/21
+
+### 0.1.1: 2019/11/25
+
+* Moves all error into top level namespace definition file.
+* Introduces a root class for all gem specific errors.
+* Renames ObjectExt to an Eventable concern.
+* Changes the aggressive extension of Object, forces a user to include the Eventable module only where necessary.
+* Moves all rails specific logic into a Railtie, which is required only if in Rails universe.
+* Adds more examples to yard documentation of the classes.
+* Adds a TODO list based on the feedback.
+* Grinds a huge GoogleCloud adapter method into smaller ones.
+* Add two 'on/off' configuration options for Rails specific components.
+* Switches to using rails specific delegate method where possible (in rails components extensions).
+
+### 0.1.0: The Big Bang
+
+* Rails controller and active job adapters
+* Generic event method
+* Handlers for GCP Pub/Sub and STDOUT
+* Initial commit
+
+
+

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 group :development, :test do
   gem "rspice"

data/Gemfile.lock

@@ -1,50 +1,51 @@
 PATH
   remote: .
   specs:
-    stenotype (0.1.0)
+    stenotype (0.1.1)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
+      spicery (>= 0.19.0, < 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.3)
-      actionpack (= 5.2.3)
+    actioncable (5.2.4)
+      actionpack (= 5.2.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
+    actionmailer (5.2.4)
+      actionpack (= 5.2.4)
+      actionview (= 5.2.4)
+      activejob (= 5.2.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
+    actionpack (5.2.4)
+      actionview (= 5.2.4)
+      activesupport (= 5.2.4)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+    actionview (5.2.4)
+      activesupport (= 5.2.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.3)
-      activesupport (= 5.2.3)
+    activejob (5.2.4)
+      activesupport (= 5.2.4)
       globalid (>= 0.3.6)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
+    activemodel (5.2.4)
+      activesupport (= 5.2.4)
+    activerecord (5.2.4)
+      activemodel (= 5.2.4)
+      activesupport (= 5.2.4)
       arel (>= 9.0)
-    activestorage (5.2.3)
-      actionpack (= 5.2.3)
-      activerecord (= 5.2.3)
+    activestorage (5.2.4)
+      actionpack (= 5.2.4)
+      activerecord (= 5.2.4)
       marcel (~> 0.3.1)
-    activesupport (5.2.3)
+    activesupport (5.2.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -52,17 +53,29 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     arel (9.0.0)
+    around_the_world (0.19.2)
+      activesupport (>= 5.2.1)
     ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
+    collectible (0.19.2)
+      activesupport (>= 5.2.1)
+      short_circu_it (= 0.19.2)
+      tablesalt (= 0.19.2)
     concurrent-ruby (1.1.5)
+    conjunction (0.19.2)
+      activesupport (>= 5.2.1)
     crass (1.0.5)
     diff-lcs (1.3)
     docile (1.3.2)
     erubi (1.9.0)
+    facet (0.19.2)
+      activesupport (>= 5.2.1)
+      short_circu_it (= 0.19.2)
+      tablesalt (= 0.19.2)
     faker (1.9.6)
       i18n (>= 0.7)
-    faraday (0.17.0)
+    faraday (0.17.1)
       multipart-post (>= 1.2, < 3)
     github-markup (3.0.4)
     globalid (0.4.2)
@@ -83,7 +96,7 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.10.1-universal-darwin)
+    google-protobuf (3.11.1)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -97,7 +110,7 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.12)
-    grpc (1.25.0-universal-darwin)
+    grpc (1.25.0)
       google-protobuf (~> 3.8)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.9)
@@ -108,26 +121,26 @@ GEM
     jaro_winkler (1.5.4)
     json (2.2.0)
     jwt (2.2.1)
-    loofah (2.3.1)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    memoist (0.16.0)
+    memoist (0.16.2)
     method_source (0.9.2)
     mimemagic (0.3.3)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.12.2)
+    minitest (5.13.0)
     multi_json (1.14.1)
     multipart-post (2.1.1)
     nio4r (2.5.2)
-    nokogiri (1.10.4)
+    nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
     os (1.0.1)
-    parallel (1.18.0)
+    parallel (1.19.1)
     parser (2.6.5.0)
       ast (~> 2.4.0)
     pry (0.12.2)
@@ -137,58 +150,73 @@ GEM
     rack (2.0.7)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.3)
-      actioncable (= 5.2.3)
-      actionmailer (= 5.2.3)
-      actionpack (= 5.2.3)
-      actionview (= 5.2.3)
-      activejob (= 5.2.3)
-      activemodel (= 5.2.3)
-      activerecord (= 5.2.3)
-      activestorage (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails (5.2.4)
+      actioncable (= 5.2.4)
+      actionmailer (= 5.2.4)
+      actionpack (= 5.2.4)
+      actionview (= 5.2.4)
+      activejob (= 5.2.4)
+      activemodel (= 5.2.4)
+      activerecord (= 5.2.4)
+      activestorage (= 5.2.4)
+      activesupport (= 5.2.4)
       bundler (>= 1.3.0)
-      railties (= 5.2.3)
+      railties (= 5.2.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    railties (5.2.4)
+      actionpack (= 5.2.4)
+      activesupport (= 5.2.4)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
     redcarpet (3.5.0)
+    redis (4.1.3)
+    redis_hash (0.19.2)
+      activesupport (>= 5.2.1)
+      redis (>= 3.0)
+      tablesalt (= 0.19.2)
     rly (0.2.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rspice (0.14.2)
-      faker (~> 1.8)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rspice (0.19.2)
+      faker (>= 1.8, < 2.0)
       rspec (~> 3.0)
-    rubocop (0.76.0)
+    rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.3.0)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.35.0)
+      rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
+    short_circu_it (0.19.2)
+      activesupport (>= 5.2.1)
+      around_the_world (= 0.19.2)
     signet (0.12.0)
       addressable (~> 2.3)
       faraday (~> 0.9)
@@ -199,6 +227,22 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    spicerack (0.19.2)
+      around_the_world (= 0.19.2)
+      redis_hash (= 0.19.2)
+      short_circu_it (= 0.19.2)
+      tablesalt (= 0.19.2)
+      technologic (= 0.19.2)
+    spicerack-styleguide (0.19.2)
+      rubocop (= 0.74)
+      rubocop-performance (= 1.4.1)
+      rubocop-rails (= 2.3.0)
+      rubocop-rspec (= 1.35.0)
+    spicery (0.19.2)
+      collectible (= 0.19.2)
+      conjunction (= 0.19.2)
+      facet (= 0.19.2)
+      spicerack (= 0.19.2)
     sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -206,6 +250,13 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    tablesalt (0.19.2)
+      activemodel (>= 5.2.1)
+      activesupport (>= 5.2.1)
+    technologic (0.19.2)
+      activesupport (>= 5.2.1)
+      railties (>= 5.2.1)
+      short_circu_it (= 0.19.2)
     thor (0.20.3)
     thread_safe (0.3.6)
     timecop (0.9.1)
@@ -229,8 +280,8 @@ DEPENDENCIES
   redcarpet (~> 3.5)
   rspec (~> 3.0)
   rspice
-  rubocop (~> 0.76)
   simplecov (~> 0.17)
+  spicerack-styleguide (>= 0.19.0, < 1.0)
   stenotype!
   timecop (~> 0.9)
   yard (~> 0.9)

data/README.md

@@ -7,7 +7,7 @@ This gem is a tool providing extensions to several rails components in order to
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'Stenotype'
+gem "Stenotype"
 ```
 
 And then execute:
@@ -32,9 +32,9 @@ Stenotype.configure do |config|
 
   config.uuid_generator = SecureRandom
   config.dispatcher     = Stenotype::Dispatcher.new
-  config.gc_project_id  = 'google_cloud_project_id'
-  config.gc_credentials = 'path_to_key_json'
-  config.gc_topic       = 'google_cloud_topic'
+  config.gc_project_id  = "google_cloud_project_id"
+  config.gc_credentials = "path_to_key_json"
+  config.gc_topic       = "google_cloud_topic"
   config.gc_mode        = :async # either :sync or :async
 end
 ```
@@ -150,7 +150,7 @@ class BaseClass
   attr_reader :local_state
 
   def initialize
-    @local_state = 'some state'
+    @local_state = "some state"
   end
 end
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/TODO.md

@@ -15,3 +15,21 @@
  - [ ] Figure out the params for plain ruby class context handler.
  - [ ] Consider `ContextHandlers::ActiveJob` params. How to deal with \_args? It won't necessarily respond to `#as_json`.
  - [ ] Consider a way to switch from evaluating ruby code to using plain modules extension.
+
+Feedback TODO:
+
+ - [x] Move all exceptions into root module Stenotype. **Moved exceptions into root module**
+ - [x] Inherit gem specific error from a root error object specific for the gem. **All gem specific error inherit from Stenotype::Errors**
+ - [x] Inherit the root error from standard error. **Stenotype::Errors inherits from StandardError**
+ - [x] Utilize concerns and allow gem users to extend the code they need with a concern rather than aggressively extend Object. **Added an Stenotype::Emitter module instead of aggressively including it into Object**
+ - [x] Use Railtie to introduce rails specific logic instead of checking whether Rails is defined in the root module. **Added a Railtie, active only in Rails world**
+ - [?] Use delegation instead of defining tiny methods. Do not forget about Demeter's. **Rails `delegate` method is used in Rails specific extensions. Otherwise simple methods are used**
+ - [x] Add more examples to yard documentation, consider collecting README.md from the yard doc. **Covered most of the classes/modules with yard examples**
+ - [x] Enable on-off triggers in the configuration to  enable/disable framework specific features. Like whether  we want to extend ActiveJob or not. **Added two configuration options for currently implemented Rails extensions**
+ - [x] Memoization! **Not actually needed**
+ - [ ] Consider potential double wrapping in the meta-programming stuff. Take a look at around-the-world and consider switching to using it.
+ - [ ] Utilize input objects for attr_readers (what was the name of the tool?)
+ - [ ] Consider configurable for configuration instead of implementing custom configuration object
+ - [ ] Consider using collectible gem to handle collection of context handlers
+ - [ ] Consider naming (e.g. #as_json => #to_h), try to be more  specific to not pollute the namespace or introduce any ambiguity.
+ - [ ] Remove freshly mentions from the gem.

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'stenotype'
+require "bundler/setup"
+require "stenotype"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'stenotype'
 # require "pry"
 # Pry.start
 
-require 'pry'
+require "pry"
 Pry.start(__FILE__)

data/lib/generators/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate the Stenotype configuration initializer.
+
+Example:
+    `rails generate stenotype:initializer`
+
+    Generates:
+      Initializer: config/initializers/stenotype.rb