serum-rails 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8618c5eef15c29da8d226c626b0ccdac8ddc952a
-  data.tar.gz: f575327bf6556db01f79fc950cbe98c16211ae12
+  metadata.gz: ab50cb542230e7195c2d5fa95e4564c075e738a5
+  data.tar.gz: 3abc89973b55f70c338024729ef70b8d747220a4
 SHA512:
-  metadata.gz: a2f95adfded11edc85309746f3c851fe0425fbdc913f2c701164fcce6f28ebf9b61972b05a4acabe958049b7dced8227de7562b4b2b74f084efc372aefab8da6
-  data.tar.gz: a050d3fb43e62e375a6a1196e789149656f9840a25106d1be8cb6641ecc1e0fa4344479f0fddd2a69130c1e4c134576c1a69186b72d7f98e260ab885f230a9bd
+  metadata.gz: c2526b799b3fb5a2a096b664ce8f9b52f5968de5ac486f696c6b4234fe3854a745e07f5c5b70cc652c45d2124e110a83f0f707be0d402744d63965e4b7e27952
+  data.tar.gz: 0bb6d3772b93ff066eef0084564b66eb9c010931e3223ea862e203d846c646b76b12d512da748196691768e3651fc56363c0e8badf750e1a607b96b818bc22a0

data/DEVELOPMENT.md

@@ -0,0 +1,8 @@
+### Run tests for gem development
+
+1. Use Ruby 2.1.2
+2. Run `bundle install` in project root
+3. Run `bundle install` in `spec/test_apps/rails-4-1`.
+4. You do **not** need to bundle in `spec/test_apps/rails-2-3`
+5. Run tests with `rspec spec`
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    serum-rails (0.2.0)
+    serum-rails (0.2.1)
       activesupport (>= 3.2)
 
 GEM

data/README.md

@@ -16,6 +16,15 @@ Since all you send us are a few numbers, we don't need to look at your code for
 estimate. This saves us signing an NDA and giving us access to your repository before
 we even work together.
 
+### Prerequisites
+
+You need:
+
+- Ruby 1.8.7 or higher
+- [Bundler](http://bundler.io/)
+- A machine that can run the project you want to generate metrics for. `serum-rails` will call `bundle` and `rake`
+  inside your project directory, so make sure you have a `database.yml` and all dependencies installed.
+  If you can open a Rails console you should be good to go.
 
 ### Installation
 
@@ -36,5 +45,27 @@ serum-rails PATH_TO_YOUR_RAILS_APPLICATION
 ```
 
 `serum-rails` will scan the code of your application and output some code metric to the console.
+It should look like this:
+
+```
+time = 2014-09-04 11:25:44
+routes = 243
+file_accesses = 66
+controller_methods = 135
+mailer_invocations = 17
+uploaders = 5
+redirects = 33
+crypto_terms = 42
+json_outputs = 0
+cookie_accesses = 7
+yaml_inputs = 0
+unescaped_strings = 59
+lines_of_code = 42784
+gems = 154
+```
 
 Please e-mail the output to your security audit contact at makandra to continue the process.
+
+### Gem development 
+
+If you want to make changes to the `serum-rails` gem itself (not required for an audit), please see `DEVELOPMENT.md` in the project root for instructions.

data/lib/serum/rails/app.rb

@@ -36,13 +36,22 @@ module Serum
       private
 
       def run_command(cmd)
-        Bundler.with_clean_env do
+        with_clean_env do
           result = `#{cmd}`
           $?.success? or raise "Error while running command: #{cmd}"
           result
         end
       end
 
+      def with_clean_env(&block)
+        # Unlike RVM, rbenv does not auto-load Bundler for gem binaries. So.
+        if defined?(Bundler)
+          Bundler.with_clean_env(&block)
+        else
+          block.call
+        end
+      end
+
       def ensure_root_exists
         File.directory?(@root) or raise "Not a directory: #{@root}"
       end

data/lib/serum/rails/version.rb

@@ -1,7 +1,7 @@
 module Serum
   module Rails
 
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serum-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- DEVELOPMENT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE