self_systeem 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c6cfe25cf61af7377e58c63bbf3ce3a9d75287
-  data.tar.gz: 69b1f86627aad4b6e6268e80f3db35e20bf2cf63
+  metadata.gz: 9de54012651cf7ecfb8be4425844e0d53df4e308
+  data.tar.gz: 27d9e804227cb2c399a5c7b9ced9f92d65c264c7
 SHA512:
-  metadata.gz: d3b41fa5008d20861a5f95436f41c2a2a9c9e9ff46e9568837616727f11cfb376917be14910db768a5ce178179b22b5b5f4411d3c75a3a28ee6105aeadddcacb
-  data.tar.gz: 4df8624646d3cfce7e6aa6240fad8e8af83eabf28de6985c45c77e5a9e7124eb05e125a5041c65f58bcd7e8d74e379085d7f7d010392ff81a5596a641c30e048
+  metadata.gz: 46267c6ddd61cec31f64abe1535c32b3d1e597b3418f23866c6591cc9f8e01def74a889f83cabd775c46ebc214d53f5f35e1bc5856c47f89527ebe07078d2f52
+  data.tar.gz: 23451262d6da7d07ded730df9eaabe0c85b706619c1b93431c6cc82abaccf13dfbc20d05289c0cebfa3afba4c8fb828d4e0069fed911c1c059b3e222b86013a7

data/README.md

@@ -1,12 +1,69 @@
-# SelfSysteem
+self_systeem
+============
+| Project                 |  Gem Release      |
+|------------------------ | ----------------- |
+| Gem name                |  self_systeem      |
+| License                 |  [MIT](LICENSE.txt)   |
+| Version                 |  [![Gem Version](https://badge.fury.io/rb/self_systeem.png)](http://badge.fury.io/rb/self_systeem) |
+| Continuous Integration  |  [![Build Status](https://travis-ci.org/mfpiccolo/self_systeem.png?branch=master)](https://travis-ci.org/mfpiccolo/self_systeem)
+| Test Coverage           |  [![Coverage Status](https://coveralls.io/repos/mfpiccolo/self_systeem/badge.png?branch=master)](https://coveralls.io/r/mfpiccolo/self_systeem?branch=coveralls)
+| Grade                   |  [![Code Climate](https://codeclimate.com/github/mfpiccolo/self_systeem.png)](https://codeclimate.com/github/mfpiccolo/self_systeem)
+| Dependencies            |  [![Dependency Status](https://gemnasium.com/mfpiccolo/self_systeem.png)](https://gemnasium.com/mfpiccolo/self_systeem)
+| Homepage                |  [http://mfpiccolo.github.io/self_systeem][homepage] |
+| Documentation           |  [http://rdoc.info/github/mfpiccolo/self_systeem/frames][documentation] |
+| Issues                  |  [https://github.com/mfpiccolo/self_systeem/issues][issues] |
 
-TODO: Write a gem description
+## Description
+
+###Definition: self-systeem
+noun
+
+1.  a realistic respect for or favorable impression of one's system
+2.  confidence in one's system worth or abilities
+3.  system-respect
+
+Do you have low self-systeem? Don't worry.  This gem is here to help.
+
+self_systeem allows you to record a users interaction with your rails app in a
+development enviornment and automatically creates system tests based on the
+recordings.
+
+It is simple.  Walk through the app from sart to finish.  Cover as much as you
+feel comfortable.  That't it.  You just built a system test.  Congrats!
+
+## Features
+
+After setting up self_systeem (see configuration below) use the generator to create
+the system test directory.
+
+`rails g self_systeem:test`
+
+Then run `SELF_SYSTEEM=true rails s`
+
+Now open a new browser preferably in incognito mode so you have fresh session.
+Walk through your app like a normal user would.  While you are doing this positive
+affirmations are being built in "test/system/support/systeem_booster.yml"
+
+Now just run the test file with `ruby -Itest test/system/systeem_test.rb` and watch
+you tests turn green.  What does this really get you?  Well for one the session and
+database is persisted while runnin all these tests.  That means that when you are running
+your tests it is essentially a recreation of all of those users actions in sequence.
+
+Possitive affirmations:
+*  "Today, my system choose to see love instead of fear"
+*  "My system possess the qualities needed to be extremely successful"
+
+Feeling better?
+
+Well if those didn't work you can always check out the affirmations that you have built in systeem_booster.yml.  That should do the trick.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'self_systeem'
+```ruby
+gem "self_systeem"
+```
 
 And then execute:
 
@@ -16,9 +73,44 @@ Or install it yourself as:
 
     $ gem install self_systeem
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+To use the generator run:
+
+    $ rails g self_systeem:test
+
+This will set up a system folder under test with a test file and some support files.
+
+Add this line to development.rb
+
+`config.middleware.use "SelfSysteem::AffirmationBuilder" if ENV["SELF_SYSTEEM"].present?`
+
+Temporarily change you database.yml so the development database uses the test database.
+This step is only while you build systeem_booster.yml file.  Chage it back when you are done.
+
+i.e.
+```ruby
+  development: &dev
+  adapter: postgresql
+  encoding: unicode
+  database: app_test # Change this back after creating the
+  pool: 5
+  username: <%= ENV["USER"] %>
+  password:
+  allow_concurrency: true
+  min_messages: warning
+```
+
+## Donating
+Support this project and [others by mfpiccolo][gittip-mfpiccolo] via [gittip][gittip-mfpiccolo].
+
+[gittip-mfpiccolo]: https://www.gittip.com/mfpiccolo/
+
+## Copyright
+
+Copyright (c) 2013 Mike Piccolo
+
+See [LICENSE.txt](LICENSE.txt) for details.
 
 ## Contributing
 
@@ -27,3 +119,11 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/3d22924e211bdc891d3ad124e085a595 "githalytics.com")](http://githalytics.com/mfpiccolo/self_systeem)
+
+[license]: https://github.com/mfpiccolo/self_systeem/MIT-LICENSE
+[homepage]: http://mfpiccolo.github.io/self_systeem
+[documentation]: http://rdoc.info/github/mfpiccolo/self_systeem/frames
+[issues]: https://github.com/mfpiccolo/self_systeem/issues
+

data/lib/generators/self_systeem/templates/systeem_test.rb

@@ -1,24 +1,32 @@
 require "./test/system/support/systeem_config.rb"
 
 describe "start_db_cleaner" do
-  before { DatabaseCleaner.start }
+  it { DatabaseCleaner.start }
 end
 
 SysteemConfig::Affirmations.each do |a|
   describe a[:controller_class_name].constantize do
     before do
+      # Only needed if devise
       @request.env["devise.mapping"] = Devise.mappings[:user]
       send(a[:request_method].downcase.to_sym, a[:action], a[:request_parameters], SysteemConfig::Session)
       SysteemConfig::Session.merge! session
     end
 
     it {
-      assert_response a[:status]
+      controller_instance = response.request.env["action_controller.instance"]
+      builder = SelfSysteem::InstanceVariablesBuilder.call(controller_instance)
+      relevant_instance_varaibles = builder.relevant_instance_varaibles
+      instance_variable_objects = builder.instance_variable_objects
 
+      assert_response a[:status]
+      assert_equal(a[:relevant_instance_varaibles], relevant_instance_varaibles.to_s)
+      assert_equal(a[:instance_variable_objects], instance_variable_objects)
+      assert_equal(a[:templates], @_templates)
     }
   end
 end
 
 describe "db_cleaner_clean" do
-  before { DatabaseCleaner.clean }
+  it { DatabaseCleaner.clean }
 end

data/lib/self_systeem.rb

@@ -1,9 +1,11 @@
 require "self_systeem/version"
 require "self_systeem/affirmation_builder"
+require "self_systeem/instance_variables_builder"
 
-module MinitestVcr
+module SelfSysteem
   def self.included(base)
     base.send(:include, SelfSysteem::AffirmationBuilder)
+    base.send(:include, SelfSysteem::InstanceVariablesBuilder)
     super
   end
 end

data/lib/self_systeem/affirmation_builder.rb

@@ -6,9 +6,11 @@ module SelfSysteem
     end
 
     def call(env)
+
       if env["REQUEST_PATH"].match(/\/assets/)
         status, headers, response = @app.call(env)
       else
+        setup_subscriptions
         status, headers, response = @app.call(env)
         request_path = env["REQUEST_PATH"]
         request_method = env["REQUEST_METHOD"]
@@ -17,26 +19,11 @@ module SelfSysteem
         request_parameters.merge!(env["rack.request.form_hash"]) if env["rack.request.form_hash"].present?
         request_parameters.merge!(env["action_controller.instance"].params.try(:to_hash)) if env["action_controller.instance"].params.present?
 
-        controller_instance = env["action_controller.instance"]
-        controller_class_name = controller_instance.try(:class).try(:name)
-        action = controller_instance.action_name
-
-        relevant_instance_varaibles = controller_instance
-          .instance_variable_names.reject {|v| v[/@_/] || v == "@marked_for_same_origin_verification"}
-        instance_variable_objects = {}
-        relevant_instance_varaibles.each do |v|
-          iv_val = controller_instance.instance_variable_get(v)
-          if iv_val.class.name.match(/ActiveRecord::AssociationRelation|ActiveRecord::Associations::CollectionProxy/)
-            instance_variable_objects.merge!(v.to_s => { })
-            iv_val.each do |o|
-              instance_variable_objects[v.to_s].merge!({ o.to_s => o.attributes })
-            end
-          elsif iv_val.is_a?(ActiveRecord::Base)
-            instance_variable_objects.merge!({ v.to_s => iv_val.attributes })
-          else
-            instance_variable_objects.merge!({ v.to_s => iv_val.to_s })
-          end
-        end
+        @controller_instance = env["action_controller.instance"]
+        controller_class_name = @controller_instance.try(:class).try(:name)
+        action = @controller_instance.action_name
+
+        setup_instance_varaibles
 
         booster = {request_method: request_method,
                           request_path: request_path,
@@ -44,8 +31,12 @@ module SelfSysteem
                     request_parameters: request_parameters,
                  controller_class_name: controller_class_name,
                                 status: status,
-           relevant_instance_varaibles: relevant_instance_varaibles.to_s,
-             instance_variable_objects: instance_variable_objects
+                              partials: @_partials,
+                               layouts: @_layouts,
+                             templates: @_templates,
+                                 files: @_files,
+           relevant_instance_varaibles: @relevant_instance_varaibles.to_s,
+             instance_variable_objects: @instance_variable_objects
         }
 
         unless File.exist?(Rails.root.to_s + "/test/system/support/systeem_booster.yml")
@@ -59,9 +50,63 @@ module SelfSysteem
         File.open(Rails.root.to_s + "/test/system/support/systeem_booster.yml", 'w') do |file|
           file.write(boosters.to_yaml)
         end
+
+        teardown_subscriptions
       end
 
       [status, headers, [response.try(:body)].flatten]
     end
+
+    def setup_instance_varaibles
+      builder = SelfSysteem::InstanceVariablesBuilder.call(@controller_instance)
+      @relevant_instance_varaibles = builder.relevant_instance_varaibles
+      @instance_variable_objects = builder.instance_variable_objects
+    end
+
+    def setup_subscriptions
+      @_partials = Hash.new(0)
+      @_templates = Hash.new(0)
+      @_layouts = Hash.new(0)
+      @_files = Hash.new(0)
+
+      ActiveSupport::Notifications.subscribe("render_template.action_view") do |_name, _start, _finish, _id, payload|
+        path = payload[:layout]
+        if path
+          @_layouts[path] += 1
+          if path =~ /^layouts\/(.*)/
+            @_layouts[$1] += 1
+          end
+        end
+      end
+
+      ActiveSupport::Notifications.subscribe("!render_template.action_view") do |_name, _start, _finish, _id, payload|
+        path = payload[:virtual_path]
+        next unless path
+        partial = path =~ /^.*\/_[^\/]*$/
+
+        if partial
+          @_partials[path] += 1
+          @_partials[path.split("/").last] += 1
+        end
+
+        @_templates[path] += 1
+      end
+
+      ActiveSupport::Notifications.subscribe("!render_template.action_view") do |_name, _start, _finish, _id, payload|
+        next if payload[:virtual_path] # files don't have virtual path
+
+        path = payload[:identifier]
+        if path
+          @_files[path] += 1
+          @_files[path.split("/").last] += 1
+        end
+      end
+    end
+
+    def teardown_subscriptions
+      ActiveSupport::Notifications.unsubscribe("render_template.action_view")
+      ActiveSupport::Notifications.unsubscribe("!render_template.action_view")
+    end
+
   end
 end

data/lib/self_systeem/instance_variables_builder.rb

@@ -0,0 +1,62 @@
+module SelfSysteem
+  class InstanceVariablesBuilder
+    include ActionView::Helpers::NumberHelper
+
+    attr_reader :controller, :relevant_instance_varaibles, :instance_variable_objects
+
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def call
+      build_variables
+      self
+    end
+
+    def build_variables
+      @relevant_instance_varaibles = controller
+        .instance_variable_names.reject {|v| v[/@_/] || v == "@marked_for_same_origin_verification"}
+      @instance_variable_objects = {}
+      relevant_instance_varaibles.each do |v|
+        iv_val = controller.instance_variable_get(v)
+        if iv_val.class.name.match(/ActiveRecord::AssociationRelation|ActiveRecord::Associations::CollectionProxy/)
+          instance_variable_objects.merge!(v.to_s => { })
+          iv_val.each do |o|
+            instance_variable_objects[v.to_s].merge!(o.attributes.select {|k, v| k.to_s.match(/^id|_id/)})
+          end
+        elsif iv_val.respond_to?(:attributes)
+          instance_variable_objects.merge!({ v.to_s => iv_val.attributes.select {|k, v| k.to_s.match(/^id|_id/)} })
+        elsif iv_val.present? && iv_val.class.ancestors.select {|c| c.to_s.match(/ActiveModel|ActiveRecord/)}.present? && iv_val.is_a?(Symbol) != true
+          instance_variable_objects.merge!({ v.to_s => slice_hash(JSON.parse(iv_val.to_json), /^id|_id/) })
+        elsif iv_val.respond_to?(:instance_values)
+          instance_variable_objects.merge!({ v.to_s => iv_val.instance_values.select {|k, v| k.to_s.match(/^id|_id/)} })
+        else
+          instance_variable_objects.merge!({ v.to_s => iv_val.to_s })
+        end
+      end
+    end
+
+    def transform_hash(original, options={}, &block)
+      original.inject({}){|result, (key,value)|
+        value = if (options[:deep] && Hash === value)
+                  transform_hash(value, options, &block)
+                else
+                  value
+                end
+        block.call(result,key,value)
+        result
+      }
+    end
+
+    def slice_hash(hash, regex)
+      transform_hash(hash, :deep => true) {|hash, key, value|
+        hash[key] = value if (value.is_a?(Hash) || key.to_s.match(regex) )
+      }
+    end
+
+    def self.call(controller)
+      new(controller).call
+    end
+
+  end
+end

data/lib/self_systeem/version.rb

@@ -1,3 +1,3 @@
 module SelfSysteem
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: self_systeem
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mike Piccolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-03 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,6 +69,7 @@ files:
 - lib/generators/self_systeem/test_generator.rb
 - lib/self_systeem.rb
 - lib/self_systeem/affirmation_builder.rb
+- lib/self_systeem/instance_variables_builder.rb
 - lib/self_systeem/version.rb
 - self_systeem.gemspec
 homepage: ''