redis_code_cov 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbf830f7068c2feeb7a459001b848f76c412cfe2
-  data.tar.gz: 57353c390b935cc3c71bd681be371a82a824b8de
+  metadata.gz: 9bafd4bef8600c1c81dac3d67786651f3a7c18aa
+  data.tar.gz: f178a593a202deecc8a9d55e07a7b987ed8d01af
 SHA512:
-  metadata.gz: 474ccd951655cc932dc6c2c0426050a2c1559953314d38e86e810d3ab027c6b121695bcb609073024efdda2034ff02537def5337b00457426cc1d815f6b0b453
-  data.tar.gz: 99c379eeffefc11f74c68888ed7a52387f7e8246d8ef14241062ef4b37ce078ebc9dc433265c3bb616aaf455d9358b571ebe54084463d95092890c62b4976bd9
+  metadata.gz: def78688ebceb1d918e03fad02cb51fd339cffc6df1c8cafff424b0fcb91f4614cfca08f918e2487ec97c30d718af1510fe75f4c69d997e3a163d29eb6c1437a
+  data.tar.gz: eead1bfd7808e1406f7d365721e34db3a9c2b641f93e78863e6130304890492eb7078c6dc983944cdd3177e7641a3c579080eef7ab1c01bb9ec364536ee21724

data/README.md

@@ -6,8 +6,6 @@ This can be a great tool to see which parts of your code are used often and perh
 
 Warning - this is ALPHA quality software, be careful before running it in production.  It will increment a Redis counter for EACH method call.  Depeneding on your traffic it could slow down your application.  
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redis_code_cov`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,18 +24,34 @@ Or install it yourself as:
 
 ## Usage
 
-Create config/initializers/redis_code_cov.rb:
+After install run `rails g redis_code_cov:install`.  Configure the gem in `config/initializers/redis_code_cov.rb`
+
+In ApplicationController (or another controller) add:
 ```ruby
-redis_conn = Redis.new(host: 'localhost', port: 6379, db: 0)
-REDIS_CODE_COV =  Redis::Namespace.new('codecov', redis: redis_conn)
+include RedisCodeCov::Controller
 ```
 
-In your ApplicationController (or another controller) add
+In ApplicationJob add:
 ```ruby
-include RedisCodeCov::Controller
+include RedisCodeCov::Job
 ```
 
-TODO - add ability to track method calls in models, views, jobs, etc.  
+Data will be stored in Redis DB and namespace configured in the initializer.  
+
+TODO:
+
+write more tests
+
+Track method calls in:
+helpers
+mailers
+models
+views
+
+For other gems:
+active model serializers
+draper decorators
+pundit policies
 
 ## Development
 

data/lib/generators/redis_code_cov/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an initializer file for gem config

data/lib/generators/redis_code_cov/install/install_generator.rb

@@ -0,0 +1,11 @@
+module RedisCodeCov
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_initializer
+        template 'redis_code_cov.rb', 'config/initializers/redis_code_cov.rb'
+      end
+    end
+  end
+end

data/lib/generators/redis_code_cov/install/templates/redis_code_cov.rb

@@ -0,0 +1,12 @@
+# => specify host connection here or in environment specific file.
+# => you can choose NOT to use namespaces or specify different driver (like :hiredis)
+if Rails.env.test?
+  REDIS_CODE_COV = Redis::Namespace.new(:codecov, redis: MockRedis.new )
+else
+  redis_conn = Redis.new(host: 'localhost', port: 6379, db: 0)
+  REDIS_CODE_COV = Redis::Namespace.new(:codecov, redis: redis_conn)
+end
+
+# => optional exclusion list of which methods NOT to record
+# => EXCLUDE_REDIS_CODE_COV = ['MyController.index', 'MyModel.method_name']
+EXCLUDE_REDIS_CODE_COV = []

data/lib/redis_code_cov.rb

@@ -3,18 +3,53 @@ require "active_support/concern"
 require "redis"
 require "redis-namespace"
 require "readthis"
+#require "after_do"
 
 module RedisCodeCov
 
+  # common code for various classes (controller, models, etc)
+  module Base
+    def redis_code_cov key
+      # => increment the counter unless ClassName.method_name is specifically excluded in initializer
+      REDIS_CODE_COV.incr key unless EXCLUDE_REDIS_CODE_COV.include? key
+    rescue Exception => e
+      # => TODO - for now just doing nothing
+    end
+  end
+
+  # controller specific code
   module Controller
+    include Base
     extend ActiveSupport::Concern
     included do
-      before_action :redis_code_cov
+      before_action do
+        key = [self.class.name, params[:action]].join('.')
+        redis_code_cov key
+      end
     end
-    def redis_code_cov
-      key = [self.class.name, params[:action]].join('.')
-      REDIS_CODE_COV.incr key
+  end
+
+  # active job code
+  module Job
+    include Base
+    extend ActiveSupport::Concern
+    included do
+      before_perform do |job|
+        # => TODO - figure out how to call it before other methods in the job class
+        key = [self.class.name, 'perform'].join('.')
+        redis_code_cov key
+      end
     end
   end
 
+  # # TODO
+  # module View
+  # end
+  # module Model
+  # end
+  # module Helper
+  # end
+  # module Mailer
+  # end
+
 end

data/lib/redis_code_cov/version.rb

@@ -1,3 +1,3 @@
 module RedisCodeCov
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/redis_code_cov.gemspec

@@ -31,11 +31,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-
   # =>
-  spec.add_runtime_dependency 'activesupport'
+  spec.add_development_dependency 'mock_redis', '~> 0.17', '>= 0.17.0'
+  # =>
+  spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.7'
   spec.add_runtime_dependency 'redis', '~> 3.3'
   spec.add_runtime_dependency 'redis-namespace', '~> 1.5'
-  spec.add_runtime_dependency 'readthis'
+  spec.add_runtime_dependency 'readthis', '~> 1.3', '>= 1.3.0'
   #spec.add_runtime_dependency 'hiredis', '~> 0.6'
+  #spec.add_runtime_dependency 'after_do', '~> 0.4', '>= 0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_code_cov
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dmitry Polyakovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.7
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +124,22 @@ dependencies:
   name: readthis
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 description: For every method call in prod it will increment a Redis counter ClassName.method_name.  Be
   careful about performance impact
 email:
@@ -127,6 +159,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/generators/redis_code_cov/install/USAGE
+- lib/generators/redis_code_cov/install/install_generator.rb
+- lib/generators/redis_code_cov/install/templates/redis_code_cov.rb
 - lib/redis_code_cov.rb
 - lib/redis_code_cov/version.rb
 - redis_code_cov.gemspec