streamliner 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e80bf0779463447c18974b34cfeef24ba408fd30
+  data.tar.gz: 6cc8279b1b3b6cab57bd4cc92378f74b16e3ea4e
+SHA512:
+  metadata.gz: d36887d34c83aa4f363b934ff7778aec87eadb998ba74bc0df543d85b3186c9d98b9955dfed4f80119992d3ad28b59656f2ae7899ae2fe25b37e696a88f0bae0
+  data.tar.gz: 26c041861d87bd35a2b88a21267e7353788cdd2c3488d23b207d97aefe5023eba7d2e08110c28dbb48c9a8ceb066f63863d215469001a374f2933ec408e9f1b4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in streamliner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Greg Baker
+
+MIT License
+
+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,20 @@
+# Streamliner
+
+Lightweight solution to measure controller usage with the aim of
+identifying unused controllers.
+
+
+Installation
+```
+gem 'streamliner'
+```
+
+To generate a report
+```
+rake streamliner:report
+```
+
+To reset usage statistics:
+```
+rake streamliner:reset
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+task :console do
+  exec "irb -r streamliner -I ./lib"
+end
+
+

data/lib/streamliner.rb

@@ -0,0 +1,11 @@
+require 'streamliner/version'
+require 'streamliner/counter'
+require 'streamliner/report'
+
+if defined?(Rails)
+  require 'streamliner/railtie'
+  require 'streamliner/controller_interceptor'
+end
+
+module Streamliner
+end

data/lib/streamliner/controller_interceptor.rb

@@ -0,0 +1,17 @@
+module Streamliner
+  module ControllerInterceptor
+
+  extend ActiveSupport::Concern
+
+    included do
+      append_before_action :count_controller
+    end
+
+    def count_controller
+      controller = params[:controller]
+      cached_count = Rails.cache.fetch(:streamliner_counter)
+      updated_count = Streamliner::Counter.new(controller, cached_count).add
+      Rails.cache.write(:streamliner_counter, updated_count)
+    end
+  end
+end

data/lib/streamliner/counter.rb

@@ -0,0 +1,27 @@
+require 'date'
+
+module Streamliner
+  class Counter
+
+    attr_reader :controller, :counter
+
+    def initialize(controller, counter)
+      @controller = controller
+      @counter = counter || Hash.new(0)
+      ensure_start_date
+    end
+
+    def add
+      counter[controller] += 1
+      counter
+    end
+
+    private
+
+    def ensure_start_date
+      if counter[:start] == 0
+        counter[:start] = DateTime.now
+      end
+    end
+  end
+end

data/lib/streamliner/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails'
+require 'streamliner/counter'
+
+module Streamliner
+  class Railtie < Rails::Railtie
+    initializer 'streamliner.action_controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include Streamliner::ControllerInterceptor
+      end
+    end
+
+    rake_tasks do
+      load 'streamliner/tasks/report.rake'
+      load 'streamliner/tasks/reset.rake'
+    end
+  end
+end

data/lib/streamliner/report.rb

@@ -0,0 +1,80 @@
+module Streamliner
+  class Report
+    attr_reader :controller_count, :controller_list, :controllers_by_use
+    attr_accessor :report
+
+    def initialize(controller_count, controller_list)
+      @controller_count = controller_count
+      @controller_list = controller_list
+      @report = String.new
+    end
+
+    def generate
+      if data_recorded?
+        add_start_date
+        add_header
+        add_usage
+        add_unused_code
+      else
+        no_data_message
+      end
+      report
+    end
+
+    private
+
+    def add_start_date
+      start = controller_count.delete(:start)
+      report << "\nSince #{start.strftime('%e %b %Y %H:%M:%S%p')} the following" +
+        " controller usage has occurred:\n\n"
+    end
+
+    def data_recorded?
+      !controller_count.nil?
+    end
+
+    def no_data_message
+      report << "No controller usage recorded\n"
+    end
+
+    def add_header
+      headers = ""
+      headers << "Controller".ljust(30)
+      headers << "Hits".ljust(10)
+      headers << "Percentage use\n"
+      report << headers
+      report << "-" * headers.chomp.length + "\n\n"
+    end
+
+    def sorted_controllers
+      controller_by_use ||= controller_count.sort_by{|k,v| v}.reverse.to_h
+    end
+
+    def add_usage
+      sorted_controllers.each do |controller, count|
+        report << "#{controller.capitalize}".ljust(30) +
+          "#{count}".ljust(10) + "#{usage_percentage(count)}%\n"
+      end
+    end
+
+    def usage_percentage count
+      sum = controller_count.values.reduce(:+)
+      ((count.to_f / sum) * 100).round(2)
+    end
+
+    def add_unused_code
+      if unused_controllers.any?
+        report << "\nThe following controllers were not used and should be considered for removal:\n\n"
+        no_usage = unused_controllers.map {|e| e.capitalize }
+        report << (Array.method_defined?(:to_sentence) ? no_usage.to_sentence : no_usage.join(', '))
+      else
+        report << "\nAll controllers were used and none are suggested for removal."
+      end
+    end
+
+    def unused_controllers
+      controller_list.map { |e|
+        e.to_s.downcase.split('controller')[0] } - sorted_controllers.keys
+    end
+  end
+end

data/lib/streamliner/tasks/report.rake

@@ -0,0 +1,10 @@
+namespace :streamliner do
+  desc 'Display count of controller hits'
+  task :report => :environment do
+    Rails.application.eager_load!
+    controller_list = ApplicationController.subclasses
+    controller_counter = Rails.cache.fetch(:streamliner_counter)
+    report = Streamliner::Report.new(controller_counter, controller_list).generate
+    puts report
+  end
+end

data/lib/streamliner/tasks/reset.rake

@@ -0,0 +1,7 @@
+namespace :streamliner do
+  desc 'Reset controller usage count'
+  task :reset => :environment do
+    Rails.cache.delete(:streamliner_counter)
+    puts "Controller usage count reset.\n"
+  end
+end

data/lib/streamliner/version.rb

@@ -0,0 +1,3 @@
+module Streamliner
+  VERSION = "0.0.2"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'streamliner'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# 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.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# 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.
+=begin
+  # 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
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  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
+end

data/spec/streamliner/counter_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Streamliner
+  describe Counter do
+    let(:counter) { Streamliner::Counter }
+    let(:params_hash_1) { "home" }
+    let(:params_hash_2) { "session" }
+
+    it 'returns a hash' do
+      result = counter.new(params_hash_1, nil).add
+      expect(result).to be_a(Hash)
+    end
+
+    it 'counts controllers passed in' do
+      result = counter.new(params_hash_1, nil).add
+      result = counter.new(params_hash_1, result).add
+      result = counter.new(params_hash_2, result).add
+      result.delete(:start)
+      expect(result).to eq({"home" => 2, "session" => 1})
+    end
+  end
+end

data/spec/streamliner/report_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Streamliner
+  describe Report do
+    let(:controllers) {
+      %w[FirstController SecondController ThirdController, ForthController]
+    }
+    let(:count) {
+      {
+        'first' => 5,
+        'second' => 3,
+        'third' => 1
+      }.merge({start: DateTime.parse('2040/1/1')})
+    }
+
+    it 'alerts the user when no usage data has been recorded' do
+      report = Report.new(nil, controllers).generate
+      expect(report).to eq("No controller usage recorded\n")
+    end
+
+    it 'generates a valid report when there is usage data' do
+      report = Report.new(count, controllers).generate
+      expect(report).to eq("\nSince  1 Jan 2040 00:00:00AM the following controller usage has occurred:\n\nController                    Hits      Percentage use\n------------------------------------------------------\n\nFirst                         5         55.56%\nSecond                        3         33.33%\nThird                         1         11.11%\n\nThe following controllers were not used and should be considered for removal:\n\nForth")
+    end
+  end
+end

data/streamliner.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'streamliner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "streamliner"
+  spec.version       = Streamliner::VERSION
+  spec.authors       = ["Greg Baker"]
+  spec.email         = ["gba311@gmail.com"]
+  spec.summary       = %q{Identifies unused controllers in Rails applications.}
+  spec.description   = %q{Lightweight solution to measure controller usage in Rails applications with the aim of identifying unused controllers.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: streamliner
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Greg Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Lightweight solution to measure controller usage in Rails applications
+  with the aim of identifying unused controllers.
+email:
+- gba311@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/streamliner.rb
+- lib/streamliner/controller_interceptor.rb
+- lib/streamliner/counter.rb
+- lib/streamliner/railtie.rb
+- lib/streamliner/report.rb
+- lib/streamliner/tasks/report.rake
+- lib/streamliner/tasks/reset.rake
+- lib/streamliner/version.rb
+- spec/spec_helper.rb
+- spec/streamliner/counter_spec.rb
+- spec/streamliner/report_spec.rb
+- streamliner.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Identifies unused controllers in Rails applications.
+test_files:
+- spec/spec_helper.rb
+- spec/streamliner/counter_spec.rb
+- spec/streamliner/report_spec.rb