rails-scope 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b86cb25451385c0e092d33d553dad6d8866bdf7
+  data.tar.gz: b7dddadbc5448dde588b1b9bf3ee5c4cdd09adb6
+SHA512:
+  metadata.gz: 20889f4050d824f74d6b1b3e2d15c078ff17031609de6d8fd4b6a435dcc36f11e7ceccfa433867eca89d340b56a677cc0f1754bcf27ff6dc51170ce6aac49071
+  data.tar.gz: 19867ec4ca2e8b49beaa87cdd630cac59f993b5460b1ea0d42c93dad56da081931f80783641ad9df442566d05304f2027ef588a55eed293dc74216abb5523c38

data/README.md

@@ -0,0 +1,11 @@
+# rails-scope
+Ruby gem that allows nVisium to accurately and automatically scope a Ruby on Rails application for assessment purposes.
+
+# Output will consist of
+
+- Code complexity
+- Routes
+- Number of Controller, Views, and Models
+- Lines of code within Controller, Views, and Models
+- # and names of RubyGems in use
+- brakeman output (--summary)

data/bin/rails-scope

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift "#{File.expand_path(File.dirname(__FILE__))}/../lib"
+
+require 'lib/rails-scope'
+
+RailsScope.run

data/lib/complexity/flay.rb

@@ -0,0 +1,9 @@
+class Flay
+  
+  def self.kick_off
+    # I only want the summary with Flay
+    o = %x{flay #{$path} -s }
+    $output_file.puts(o)
+  end
+  
+end

data/lib/complexity/flog.rb

@@ -0,0 +1,9 @@
+class Flog
+  
+  def self.kick_off
+    # Run Flog and take everything it gives
+    o = %x{flog #{$path} }
+    $output_file.puts(o)
+  end
+  
+end

data/lib/count/code_count.rb

@@ -0,0 +1,80 @@
+class CodeCount
+  
+  attr_accessor :directories, :files, :entries
+  attr_reader :target_dir
+  
+  def self.kick_off
+    @directories = []
+    @files = []
+    # We need to get the line of code_count, directory count, file count, and 
+    # ...names from the app dir
+    @target_dir = "#{$path}/app"
+    if Dir.exist?(@target_dir)
+      create_count
+    else
+      $output_file.puts("We weren't able to find the app/ directory looking here: #{@target_dir}")
+    end
+  end
+  
+  def self.uninteresting_directories
+    %w{ . .. assets }
+  end  
+
+
+  # This method is just hideous but... hackathon = mvp
+  def self.collect_assets
+    @entries = Dir.entries @target_dir 
+    @entries.delete_if {|dir| uninteresting_directories.include? dir }
+    @entries.each do |top_level_dir|
+      files_and_folders = Dir.glob("#{@target_dir}/#{top_level_dir}/**/*") 
+      assets = files_and_folders.each do |file_or_fold| 
+        if File.directory?(file_or_fold)
+          @directories << file_or_fold
+        elsif File.file?(file_or_fold)
+          @files << file_or_fold
+        end
+      end
+    end
+  end
+  
+  def self.print_out_info
+    ['directories', 'files'].each_with_index do |item, idx|
+       $output_file.puts("The following are the names of the #{item.capitalize}: ")
+       $output_file.puts("-" * 30)
+       instance_variable_get("@#{item}").each do |asset|
+         $output_file.puts asset
+       end
+       $output_file.puts("\n")
+    end
+    
+    # Being Duplication that really should be fixed
+    $output_file.puts("The following is the individual file LoC: ")
+    $output_file.puts("-" * 30)
+    $output_file.puts("\n")
+    @files.each do |file|
+      $output_file.puts(loc_in_file(file))
+    end
+    $output_file.puts("\n")
+    $output_file.puts("The following is the LoC for folders under the app directory: ")
+    $output_file.puts("-" * 30)
+    $output_file.puts("\n")
+    @entries.each do |entry|
+      $output_file.puts("#{loc_in_dir(entry)[/(\d+ total)/]}: #{entry}")
+    end
+  end
+  
+  def self.loc_in_file(file)
+    %x{wc -l #{file} }
+  end
+  
+  def self.loc_in_dir(dir)
+     %x{find . #{@target_dir}/#{dir} |xargs wc -l }
+   end
+  
+  
+  def self.create_count
+    collect_assets
+    print_out_info
+  end
+
+end

data/lib/count/gemfile.rb

@@ -0,0 +1,10 @@
+class Gemfile
+  
+  def self.kick_off
+    gemfile = "#{$path}/Gemfile"
+    if File.exists?(gemfile)
+      $output_file.puts File.read(gemfile)
+    end
+  end
+  
+end

data/lib/rails-scope.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+require 'tmpdir'
+require 'security/brakeman'
+require 'complexity/flog'
+require 'complexity/flay'
+require 'count/code_count'
+require 'count/gemfile'
+
+class RailsScope
+  
+  attr_reader :options
+  
+  def self.run
+    @options = {}
+    OptionParser.new do |opts|
+      opts.banner = "Usage: rails-scope [options]"
+      
+      opts.on("-p", "--path /var/app/current", "Path to your application directory") do |p|
+        @options[:path] = p
+      end
+
+      opts.on("-o", "--path /my/dir", "The location you would like the scope.nv file stored") do |o|
+        @options[:output] = o
+      end
+
+      opts.on("-h", "--help", "Displays help information") do
+        puts opts 
+        exit
+      end
+    end.parse!
+    start
+  end
+  
+  def self.klasses
+    %w{ Brakeman Flog Flay CodeCount Gemfile}
+  end
+  
+  def self.separator(tool_name='')
+    sep = tool_name == klasses.first ? "" : "\n"
+    sep << "=" * 15
+    sep << tool_name
+    sep << "=" * 15
+    sep << "\n\n"
+    $output_file.puts sep
+  end
+  
+  def self.start
+    $path   = @options[:path] ? @options[:path] : Dir.pwd
+    $output_path = @options[:output] ? @options[:output] : Dir.pwd
+    $output_file = File.new("#{$output_path}/scope.nv", "w")
+    $tmpdir = Dir.mktmpdir
+    klasses.each do |klass|
+      separator(klass.to_s)
+      obj = Object.const_get(klass)
+      obj.kick_off
+    end
+  ensure 
+    clean_up
+  end
+  
+  def self.clean_up
+   puts "#{$output_file}"
+   $output_file.close
+  ensure
+    FileUtils.remove_entry_secure $tmpdir if !$tmpdir.nil? && Dir.exists?($tmpdir)
+  end
+  
+end

data/lib/security/brakeman.rb

@@ -0,0 +1,9 @@
+class Brakeman
+  
+  def self.kick_off
+    # run brakeman and generate report
+    o = %x{ brakeman #{$path} --summary }
+    $output_file.puts(o)
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rails-scope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ken Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-06 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: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: "\n  \t\t\t\t\t\tRuby gem that allows nVisium to accurately and automatically
+  scope a Ruby on Rails application for assessment purposes.\n                        "
+email:
+- contact@nvisium.com
+executables:
+- rails-scope
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/rails-scope
+- lib/complexity/flay.rb
+- lib/complexity/flog.rb
+- lib/count/code_count.rb
+- lib/count/gemfile.rb
+- lib/rails-scope.rb
+- lib/security/brakeman.rb
+homepage: https://github.com/nVisium/rails-scope
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- "."
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Assists nVisium in scoping and pricing Rails assessments for our clients.
+test_files: []