system_tester 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652bc548a774e0a42ba29b0f818edc42a117110b
-  data.tar.gz: 6206c7c9aac64360a585ee95774f2d2b500d1a10
+  metadata.gz: 6e1676f61e29bae6df5fa24162aeb38db69c0057
+  data.tar.gz: a14e44f9d56dc8d3cffed29687dccfd097adc111
 SHA512:
-  metadata.gz: 14015439db14beb2713aa26f304b491a581eff222362dbb6aed978994f051815fdd0de5b490aa9059fc36b784bbcb925d25b24034b69c199a20b1f7c75f482fb
-  data.tar.gz: 8d623a4a103cd31533ebe64bb1017f0ec3adbaadb22de4eda2ec20d269740fa4e3777e02e48acb0c425531e37127bb28ae282cfec1a31f293d9aebd0568ca3e0
+  metadata.gz: b195eb78288b845aadbaea925bc1278248bd021ee641d14172db8407e9a3027d4e35ba5369c3fd9384c0f362597b77719a4162d827749e43d088b76090e8a384
+  data.tar.gz: b9c442b45b13f5bcd474c178212dd0ab444bc0a7f77bed7a56a76b48826dcc8c66c19a790b3e6a49ab9c5e7132d641ead993a26e09e70d348727bc3a8328ab45

data/README.md

@@ -23,7 +23,7 @@ system_tester:
 And then install and run the migrations:
 ```bash
 $ bundle install
-$ RAILS_ENV=system_tester rails db:migrate
+$ rails system_tester:migrate
 ```
 
 Mount the engine in config/routes.rb:
@@ -41,6 +41,8 @@ end
 Start your dev server and you are good to go.
 
 ## Chrome extension
+![image](screenshot.png)
+
 The chrome extension provides a Devtools tab and acts as a client to this gem.
 
 IN DEVELOPMENT - to request access feel free to dm on twitter @ralafranchi.
@@ -59,6 +61,3 @@ testing steps:
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## TODOS
- * File management and hooks to create the scripts. To get the code for a feature you can call `to_s` on it.

data/app/controllers/system_tester/application_controller.rb

@@ -1,15 +1,5 @@
 module SystemTester
   class ApplicationController < ActionController::API
     # protect_from_forgery with: :exception
-    # before_action :set_headers
-
-    private
-
-    def set_headers
-      headers['Access-Control-Allow-Origin'] = 'http://localhost:8080'
-      headers['Access-Control-Allow-Methods'] = 'POST, PUT, DELETE, GET, OPTIONS'
-      headers['Access-Control-Request-Method'] = '*'
-      headers['Access-Control-Allow-Headers'] = 'Origin, X-Requested-With, Content-Type, Accept, Authorization'
-    end
   end
 end

data/app/controllers/system_tester/features_controller.rb

@@ -26,7 +26,7 @@ module SystemTester
 
     def destroy
       Feature.find(params[:id]).destroy!
-      render head: :ok
+      render json: {}
     end
 
     private

data/app/controllers/system_tester/scenario_steps_controller.rb

@@ -23,7 +23,7 @@ module SystemTester
 
     def destroy
       ScenarioStep.find(params[:id]).destroy!
-      render head: :ok
+      render json: {}
     end
 
     private

data/app/controllers/system_tester/scenarios_controller.rb

@@ -31,7 +31,7 @@ module SystemTester
 
     def destroy
       Scenario.find(params[:id]).destroy!
-      render head: :ok
+      render json: {}
     end
 
     private

data/app/controllers/system_tester/stair_steps_controller.rb

@@ -23,7 +23,7 @@ module SystemTester
 
     def destroy
       StairStep.find(params[:id]).destroy!
-      render head: :ok
+      render json: {}
     end
 
     private

data/app/controllers/system_tester/steps_controller.rb

@@ -34,7 +34,7 @@ module SystemTester
 
     def destroy
       Step.find(params[:id]).destroy!
-      render head: :ok
+      render json: {}
     end
     
     private

data/app/models/concerns/system_tester/fileable.rb

@@ -0,0 +1,83 @@
+require 'fileutils'
+
+module SystemTester
+  module Fileable
+    extend ActiveSupport::Concern
+
+    included do
+      before_save do
+        FileUtils.mkdir_p(base_path)
+        unless File.exists?(system_test_case_path)
+          File.open(system_test_case_path, "w+") { |f| f.write(system_test_case_content) }
+        end
+      end
+
+      after_touch do
+        save_file
+      end
+
+      before_create do
+        save_file
+      end
+
+      before_update do
+        if title_changed?
+          delete_old_file
+        end
+        save_file
+      end
+
+      before_destroy do
+        delete_file
+      end
+
+      private
+
+      def test_path
+        Rails.root.join("test")
+      end
+
+      def base_path
+        File.join(test_path, base_dir)
+      end
+
+      def full_file
+        File.join(base_path, file_name)
+      end
+
+      def old_file
+        File.join(base_path, file_name_was)
+      end
+
+      def delete_file
+        File.delete(full_file)
+      end
+
+      def delete_old_file
+        File.delete(old_file)
+      end
+
+      def save_file
+        File.open(full_file, 'w+') do |f|
+          f.write(code_to_write)
+        end
+      end
+
+      def system_test_case_path
+        File.join(base_path, "system_tester_system_test_case.rb")
+      end
+
+      def system_test_case_content
+        <<EOF
+require "test_helper"
+
+module SystemTester
+  class SystemTesterSystemTestCase < ActionDispatch::SystemTestCase
+    driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+  end
+end
+EOF
+      end
+    end
+  end
+end

data/app/models/system_tester/feature.rb

@@ -1,6 +1,7 @@
 module SystemTester
   class Feature < ApplicationRecord
     include SystemTester::TitleValidatable
+    include SystemTester::Fileable
     validates_uniqueness_of :title
 
     has_many :scenarios, foreign_key: "system_tester_feature_id", class_name: 'SystemTester::Scenario', dependent: :destroy
@@ -12,14 +13,18 @@ module SystemTester
       str << close
       str
     end
+    alias_method :code_to_write, :to_s
 
     private
 
     def open
       str = ""
-      str << "require 'application_system_test_case'\n\n"
+      stairs.each do |stair|
+        str << "require 'support/system_tester/#{stair.method_name}'\n"
+      end
+      str << "require_relative 'system_tester_system_test_case'\n\n"
       str << "module SystemTester\n"
-      str << "  class #{stripped_title.camelize}Test < ApplicationSystemTestCase\n"
+      str << "  class #{stripped_title.camelize}Test < SystemTesterSystemTestCase\n"
       stairs.each do |stair|
         str << "    include #{stair.module_name}\n"
       end
@@ -35,8 +40,24 @@ module SystemTester
       title.gsub(/\s+/,"")
     end
 
+    def stripped_title_was
+      title_was.gsub(/\s+/,"")
+    end
+
     def stairs
       Stair.joins(:scenarios).where("system_tester_scenarios.system_tester_feature_id = ?", id)
     end
+
+    def base_dir
+      File.join("system", "system_tester")
+    end
+
+    def file_name
+      "#{stripped_title.underscore}_test.rb"
+    end
+
+    def file_name_was
+      "#{stripped_title_was.underscore}_test.rb"
+    end
   end
 end

data/app/models/system_tester/scenario.rb

@@ -12,6 +12,10 @@ module SystemTester
              dependent: :destroy
     has_many :steps, -> { order 'position asc' }, through: :scenario_steps
 
+    after_commit do
+      feature.touch if feature.present?
+    end
+
     def to_s
       str = ""
       str << open

data/app/models/system_tester/scenario_step.rb

@@ -3,5 +3,9 @@ module SystemTester
     belongs_to :step, class_name: "SystemTester::Step", foreign_key: "system_tester_step_id"
     belongs_to :scenario, class_name: "SystemTester::Scenario", foreign_key: "system_tester_scenario_id"
     acts_as_list scope: :system_tester_scenario_id
+
+    after_commit do
+      scenario.feature.touch if scenario.present? && scenario.feature.present?
+    end
   end
 end

data/app/models/system_tester/stair.rb

@@ -1,5 +1,6 @@
 module SystemTester
   class Stair < Step
+    include SystemTester::Fileable
     has_many :stair_steps,
              -> { order 'position asc' },
              class_name: "SystemTester::StairStep",
@@ -8,7 +9,7 @@ module SystemTester
     has_many :steps, -> { order 'position asc' }, through: :stair_steps
 
     def to_s
-      "#{INDENT}# Stair #{title}\n#{INDENT}#{method_name}\n\n"
+      "#{INDENT}# Stair: #{title}\n#{INDENT}#{method_name}\n\n"
     end
 
     def module
@@ -18,11 +19,16 @@ module SystemTester
       str << close
       str
     end
+    alias_method :code_to_write, :module
 
     def module_name
       stripped_title.camelize
     end
 
+    def method_name
+      stripped_title.underscore
+    end
+
     def icon
       "clear_all"
     end
@@ -49,8 +55,24 @@ module SystemTester
       title.gsub(/\s+/,"")
     end
 
-    def method_name
-      stripped_title.underscore
+    def stripped_title_was
+      title_was.gsub(/\s+/,"")
+    end
+
+    def method_name_was
+      stripped_title_was.underscore
+    end
+
+    def base_dir
+      File.join("support", "system_tester")
+    end
+
+    def file_name
+      "#{method_name}.rb"
+    end
+
+    def file_name_was
+      "#{method_name_was}.rb"
     end
   end
 end

data/app/models/system_tester/stair_step.rb

@@ -3,5 +3,9 @@ module SystemTester
     belongs_to :step, class_name: "SystemTester::Step", foreign_key: "system_tester_step_id"
     belongs_to :stair, class_name: "SystemTester::Stair", foreign_type: "SystemTester::Stair", foreign_key: "system_tester_stair_id"
     acts_as_list scope: :system_tester_stair_id
+
+    after_commit do
+      stair.touch if stair.present?
+    end
   end
 end

data/app/models/system_tester/step.rb

@@ -16,12 +16,21 @@ module SystemTester
              dependent: :destroy
     has_many :stairs, through: :stair_steps
 
+    after_commit do
+      stairs.each do |stair|
+        stair.touch
+      end
+      scenarios.each do |scenario|
+        scenario.feature.touch if scenario.feature.present?
+      end
+    end
+
     def self.friendly_type
       name.demodulize
     end
 
     def self.parent_type
-      ancestors.fourth.name.demodulize
+      ancestors.fourth.name ? ancestors.fourth.name.demodulize : "Step"
     end
 
     def self.bg_css

data/db/migrate/20170513131150_create_system_tester_features.rb

@@ -1,9 +1,8 @@
 class CreateSystemTesterFeatures < ActiveRecord::Migration[5.1]
   def change
-    if Rails.env.system_tester?
-      create_table :system_tester_features do |t|
-        t.string :title
-      end
+    create_table :system_tester_features do |t|
+      t.string :title
+      t.timestamps
     end
   end
 end

data/db/migrate/20170513213953_create_system_tester_scenarios.rb

@@ -1,10 +1,9 @@
 class CreateSystemTesterScenarios < ActiveRecord::Migration[5.1]
   def change
-    if Rails.env.system_tester?
-      create_table :system_tester_scenarios do |t|
-        t.string :title
-        t.references :system_tester_feature, foreign_key: true
-      end
+    create_table :system_tester_scenarios do |t|
+      t.string :title
+      t.references :system_tester_feature, foreign_key: true
+      t.timestamps
     end
   end
 end

data/db/migrate/20170513214255_create_system_tester_steps.rb

@@ -1,12 +1,11 @@
 class CreateSystemTesterSteps < ActiveRecord::Migration[5.1]
   def change
-    if Rails.env.system_tester?
-      create_table :system_tester_steps do |t|
-        t.string :title
-        t.string :type
-        t.string :arg_one
-        t.string :arg_two
-      end
+    create_table :system_tester_steps do |t|
+      t.string :title
+      t.string :type
+      t.string :arg_one
+      t.string :arg_two
+      t.timestamps
     end
   end
 end

data/db/migrate/20170513214722_create_system_tester_scenario_steps.rb

@@ -1,11 +1,10 @@
 class CreateSystemTesterScenarioSteps < ActiveRecord::Migration[5.1]
   def change
-    if Rails.env.system_tester?
-      create_table :system_tester_scenario_steps do |t|
-        t.integer :position
-        t.references :system_tester_step, foreign_key: true
-        t.references :system_tester_scenario, foreign_key: true, index: {name: "index_st_st_scenario_id"}
-      end
+    create_table :system_tester_scenario_steps do |t|
+      t.integer :position
+      t.references :system_tester_step, foreign_key: true
+      t.references :system_tester_scenario, foreign_key: true, index: {name: "index_st_st_scenario_id"}
+      t.timestamps
     end
   end
 end

data/db/migrate/{20170629120850_create_stair_steps.rb → 20170629120850_create_system_tester_stair_steps.rb}

@@ -1,9 +1,10 @@
-class CreateStairSteps < ActiveRecord::Migration[5.1]
+class CreateSystemTesterStairSteps < ActiveRecord::Migration[5.1]
   def change
     create_table :system_tester_stair_steps do |t|
       t.integer :position
       t.references :system_tester_step, foreign_key: true
       t.references :system_tester_stair, foreign_key: { to_table: :system_tester_steps }
+      t.timestamps
     end
   end
 end

data/db/schema.rb

@@ -14,12 +14,16 @@ ActiveRecord::Schema.define(version: 20170629120850) do
 
   create_table "system_tester_features", force: :cascade do |t|
     t.string "title"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
   create_table "system_tester_scenario_steps", force: :cascade do |t|
     t.integer "position"
     t.integer "system_tester_step_id"
     t.integer "system_tester_scenario_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
     t.index ["system_tester_scenario_id"], name: "index_st_st_scenario_id"
     t.index ["system_tester_step_id"], name: "index_system_tester_scenario_steps_on_system_tester_step_id"
   end
@@ -27,6 +31,8 @@ ActiveRecord::Schema.define(version: 20170629120850) do
   create_table "system_tester_scenarios", force: :cascade do |t|
     t.string "title"
     t.integer "system_tester_feature_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
     t.index ["system_tester_feature_id"], name: "index_system_tester_scenarios_on_system_tester_feature_id"
   end
 
@@ -34,6 +40,8 @@ ActiveRecord::Schema.define(version: 20170629120850) do
     t.integer "position"
     t.integer "system_tester_step_id"
     t.integer "system_tester_stair_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
     t.index ["system_tester_stair_id"], name: "index_system_tester_stair_steps_on_system_tester_stair_id"
     t.index ["system_tester_step_id"], name: "index_system_tester_stair_steps_on_system_tester_step_id"
   end
@@ -43,6 +51,8 @@ ActiveRecord::Schema.define(version: 20170629120850) do
     t.string "type"
     t.string "arg_one"
     t.string "arg_two"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
 end

data/lib/system_tester.rb

@@ -1,4 +1,4 @@
-
+require "rack/cors"
 require "acts_as_list"
 require "system_tester/engine"
 

data/lib/system_tester/engine.rb

@@ -3,9 +3,15 @@ module SystemTester
     isolate_namespace SystemTester
     config.generators.api_only = true
 
-    initializer :override_db_dir do |app|
-      if Rails.env.system_tester?
-        app.config.paths["db"] = config.paths['db'].expanded
+    initializer :cors do |app|
+      app.config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          origins '*'
+          resource '/system_tester/*',
+                   :headers => :any,
+                   :methods => [:get, :post, :delete, :put, :patch, :options, :head]
+
+        end
       end
     end
 

data/lib/system_tester/version.rb

@@ -1,3 +1,3 @@
 module SystemTester
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/tasks/system_tester_tasks.rake

@@ -1,5 +1,33 @@
 # desc "Explaining what the task does"
 # create install task
-# task :system_tester do
-#   # Task goes here
-# end
+# TODO:
+#   - potentially load using sql instead of migrations
+#   - auto mount in the routes
+#   - auto add to database.yml defaulting to sqlite3
+#   - create test directories
+#   - copy system_tester_system_test_case
+
+# remove migration copy in favor of custom migration task
+Rake::Task["system_tester:install:migrations"].clear
+namespace :system_tester do
+  namespace :install do
+    desc "(Not Supported)"
+    task "migrations" do
+      # do nothing
+      puts "Not supported..."
+    end
+  end
+
+  # see ActiveRecord::Tasks::DatabaseTasks
+  desc "Running migrations for the System Tester db"
+  task :migrate => :environment do
+    include ActiveRecord::Tasks
+    ENV['RAILS_ENV'] = "system_tester"
+    DatabaseTasks.db_dir = Rails.root.join("db")
+    DatabaseTasks.env = "system_tester"
+    DatabaseTasks.migrations_paths = [SystemTester::Engine.root.join("db", "migrate")]
+    DatabaseTasks.root = Rails.root
+    DatabaseTasks.create_current("system_tester")
+    DatabaseTasks.migrate
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: system_tester
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Richard LaFranchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +85,7 @@ files:
 - app/controllers/system_tester/step_types_controller.rb
 - app/controllers/system_tester/steps_controller.rb
 - app/jobs/system_tester/application_job.rb
+- app/models/concerns/system_tester/fileable.rb
 - app/models/concerns/system_tester/title_validatable.rb
 - app/models/system_tester/action.rb
 - app/models/system_tester/application_record.rb
@@ -91,7 +106,7 @@ files:
 - db/migrate/20170513213953_create_system_tester_scenarios.rb
 - db/migrate/20170513214255_create_system_tester_steps.rb
 - db/migrate/20170513214722_create_system_tester_scenario_steps.rb
-- db/migrate/20170629120850_create_stair_steps.rb
+- db/migrate/20170629120850_create_system_tester_stair_steps.rb
 - db/schema.rb
 - lib/system_tester.rb
 - lib/system_tester/engine.rb