hocus_pocus 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eca0d66944e5a36d17491259d52e0fd076578425
-  data.tar.gz: 9b6c14bd4bc5f261bfed810594ef31303267ec63
+SHA256:
+  metadata.gz: c50f4663cf52a24e1af23e866e8ba90564c9ae6cd041c8a2aef7d8e6fc636ccf
+  data.tar.gz: 219f63589b0736115d11e761df2c88502243da4b43b81e554926a8a13fd4189e
 SHA512:
-  metadata.gz: e05c8b8f5937608cae75370ea4ec7958e2e521d7b11b1e30a8517a3925c0f9704468ca7e4844f3af9dc8c09c4c89bf1d5498ddd0bbed6b6b2c91c57474492eed
-  data.tar.gz: f0116cac8f20e54c9f5df6fcb374b119d6a0744b99ca447fd9dd43e0575e6ed3b10df43fee75feb4f2b66803a0194169a0f149e08d0da4271b493bf3ebc57e90
+  metadata.gz: 0dcb97d7aa7d4b53fb39ff5561dcb1e07b6cb0b863569ebb257ab813ccb92d0d431b25b488bc8173e3701ec872a073e77fa68a2678cad2c3bbdb048e989563a3
+  data.tar.gz: 598eff9be126b971a5de919c78878a598196d7a86dfed0f870c25bcb559ca8d7689624d4164d2b0f1b3a276f3f644054b34d21f07da4aec8860fd0b0e91d2e59

data/README.md

@@ -0,0 +1,118 @@
+# hocus_pocus
+
+hocus_pocus is a gem library which casts a spell on your Rails app and enables you to build your Rails app "on the fly" just like editing a Wiki.
+
+## Features
+
+(this documentation is copied from an ancient [blog post](https://web.archive.org/web/20120113014943/http://blog.dio.jp/2010/12/21/hocus_pocus)).
+
+
+### 1. Request Driven Generator
+
+You, well grounded Railers, always start your development with URL designing, right? You know, that's "the Rails Way". So, as you decide the URL, just put it in your browser's URL window.
+
+
+![](doc/assets/hp_localhost_3000.png)
+
+This engine catches the "routing missing" sort of request, then urges you to input the parameters for the scaffold generator for the "missing" resource.
+
+![](doc/assets/hp_scaffold.png)
+
+When the params are submitted, the engine kicks the scaffold generator on the server, and redirects you back to the generated index action.
+
+![](doc/assets/hp_scaffolded.png)
+
+This is what I meant by "request driven". This idea is strongly inspired by "Ymir" framework, which has been developed by YOKOTA Takehiko (@i_am_skirnir) in Java language. As I took a look at this, I thought, "hey, even Java can do live code generation through browser. Why can't Rails do that?"
+
+
+### 2. View Editor
+
+I guess you're always frustrated that you have to switch between your text editor and browser again and again while developing web apps. This engine magically enables you to edit your view file dynamically on your web browser just like a Wiki by clicking the "edit" button on the top right (this is why this product was previously called "wiki_mode" engine).
+
+![](doc/assets/hp_editing_show.png)
+
+Of course you can edit the partials as well.
+
+![](doc/assets/hp_editing_partial.png)
+
+
+### 3. url_for-missing Driven Generator
+
+Now, as you edit your view, you probably want to `link_to` or build a `form_for` a resource that does not exist yet, because it's a quite natural way for editing a Wiki. OK, now you can do it that way. Simply add a `link_to` like this, and submit the form.
+
+![](doc/assets/hp_adding_users_path.png)
+
+Then another magic happens here. This time, the engine rescues "url_for missing" as well, and leads you to the generator again.
+
+
+### 4. Generating Nested Resources
+
+As you put a `link_to` a nested resource like `post_comments_path(@post)`,
+
+![](doc/assets/hp_adding_post_comments_path.png)
+
+the engine suggests you to generate a nested resource.
+
+![](doc/assets/hp_nested_scaffold.png)
+
+This generates a perfectly working set of code with the following routes.
+
+```ruby
+resources :posts do
+  resources :comments
+end
+```
+
+This is done by another library named [nested_scaffold](https://github.com/amatsuda/nested_scaffold) generator.
+
+
+### 5. Steak (Capybara) Recorder
+
+These days we're getting familiar with writing end-to-end testing in Ruby code. In the test code, we visit a page, `fill_in` text fields, `select` value from drop downs, `click` buttons, and then `assert` values in the page body by operating a virtual browser by Ruby. But, wait. Do you test only by code? Aren't you doing exactly the same thing by hand anyway? And isn't it easier and faster to manipulate the browser than writing Ruby code? So, isn't it nice if an integration test scenario can automatically be generated while you operate your browser? This engine records what you did in your browser,
+
+![](doc/assets/hp_before_steak.png)
+
+and outputs a scenario for Steak (Capybara).
+
+![](doc/assets/hp_steak.png)
+
+Comparing to usual generator generated test cases, this scenario might be quite useful and practical since it uses the actual data you entered.
+
+
+### 6. Speed
+
+This is not actually a "feature", but an unignorable benefit of this product. Every time we hit "rails" command or "rake" command on Rails 3, we're forced to wait several seconds for the Rails process to start up. However, because the generator is directly executed inside the running Rails server process, the hocus_pocus generator runs incredibly fast. When you run the generator from browser, it actually invokes
+
+```sh
+% rails generate scaffold
+% rake db:migrate
+```
+
+and usually finishes within a second on my mac.
+
+
+## Demo
+
+Finally, to see how it works, [here's my live demonstration video](http://www.nicovideo.jp/watch/sm12976168) at Sapporo RubyKaigi 03.
+
+Though the talk were in japanese, I think you all can get the idea since the main part of the talk were live demo.
+
+I know it's super buggy ATM (thus still versioned as 0.0.0), needs tons of improvement, but has a great potential to change your development style. The source code is of course available on GitHub.
+
+Have fun!
+
+
+## Questions, Feedback
+
+Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda)  ☇3☇3☇3
+
+
+## Contributing to hocus_pocus
+
+* Fork, fix, then send me a pull request.
+
+
+## Copyright
+
+Copyright (c) 2010- Akira Matsuda. See MIT-LICENSE for
+further details.

data/engines/command_line/lib/hocus_pocus/command_line/middleware.rb

@@ -10,16 +10,28 @@ module HocusPocus
       end
 
       def call(env)
-        @app.call(env).tap do |status, headers, body|
-          if body.is_a?(ActionDispatch::Response) && body.request.format.html?
-            body.body = insert_text body.body, :after, /<div id="#{HocusPocus::CONTAINER}" .*?>/i, command_line_link
+        status, headers, body = @app.call env
+
+        if headers && headers['Content-Type']&.include?('text/html') && (env['REQUEST_PATH'] !~ %r[^/*hocus_pocus/])
+          case body
+          when ActionDispatch::Response, ActionDispatch::Response::RackBody
+            body = body.body
+          when Array
+            body = body[0]
           end
+
+          body.sub!(/<\/head>/i) { %Q[<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script></head>] } unless body =~ /jquery(\.min)?\.js/
+          body.sub!(/<div id="#{HocusPocus::CONTAINER}" .*?>/i) { %Q[#{$~}#{command_line_link}] }
+
+          [status, headers, [body]]
+        else
+          [status, headers, body]
         end
       end
 
       private
       def command_line_link
-        %Q[<a href="#" onclick="$(this).closest('div').find('div.command_line_form').toggle()">cmd</a><div class="command_line_form" style="display:none;"><form method="post" action="/hocus_pocus/command_line/execute" data-remote="true"><input type="text" name="command" placeholder="Command?" style="width: 512px;" /><input type="submit" name="run" /></form></div>]
+        %Q[<a href="#" onclick="$(this).closest('div').find('div.command_line_form').toggle(); return false;">cmd</a><div class="command_line_form" style="display:none;"><form method="post" action="/hocus_pocus/command_line/execute" data-remote="true"><input type="text" name="command" placeholder="Command?" style="width: 512px;" /><input type="submit" name="run" /></form></div>]
       end
     end
   end

data/engines/editor/app/views/hocus_pocus/editor/editor/_editor.html.erb

@@ -6,7 +6,7 @@
     <%= hidden_field_tag :path, @path %>
     <%= text_area_tag :file, @file, :size => '100x30' %>
     <div id="actions">
-      <%= button_to_function 'Hide', "$('#__editor__').hide()", :class => "hide" %>
+      <%= tag(:input, type: 'button', value: 'Hide', class: 'hide', onclick: "$('#__editor__').hide()") %>
       <%= submit_tag 'Save!', :class => "save" %>
     </div>
   <% end %>

data/engines/editor/lib/hocus_pocus/editor/middleware.rb

@@ -10,13 +10,26 @@ module HocusPocus
       end
 
       def call(env)
-        @app.call(env).tap do |status, headers, body|
-          if body.is_a?(ActionDispatch::Response) && body.request.format.html?
-            if Thread.current[HocusPocus::Editor::VIEW_FILENAME]
-              body.body = insert_text body.body, :after, /<div id="#{HocusPocus::CONTAINER}" .*?>/i, %Q[#{edit_link}#{partials}]
-              Thread.current[HocusPocus::Editor::VIEW_FILENAME] = nil
-            end
+        status, headers, body = @app.call env
+
+        if headers && headers['Content-Type']&.include?('text/html') && (env['REQUEST_PATH'] !~ %r[^/*hocus_pocus/])
+          case body
+          when ActionDispatch::Response, ActionDispatch::Response::RackBody
+            body = body.body
+          when Array
+            body = body[0]
+          end
+
+          if Thread.current[HocusPocus::Editor::VIEW_FILENAME]
+            body.sub!(/<div id="#{HocusPocus::CONTAINER}" .*?>/i) { %Q[#{$~}#{edit_link}#{partials}] }
+            Thread.current[HocusPocus::Editor::VIEW_FILENAME] = nil
           end
+
+          body.sub!(/<\/head>/i) { %Q[<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script></head>] } unless body =~ /jquery(\.min)?\.js/
+
+          [status, headers, [body]]
+        else
+          [status, headers, body]
         end
       end
 

data/engines/editor/lib/hocus_pocus/editor/railtie.rb

@@ -6,6 +6,20 @@ module HocusPocus
     VIEW_FILENAME = :__hocus_pocus_view_filename__
     PARTIAL_FILENAMES = :__hocus_pocus_partial_filenames__
 
+    module PartialRendererExtension
+      def render_partial
+        (Thread.current[HocusPocus::Editor::PARTIAL_FILENAMES] ||= []) << @template unless @view.controller.class.name.starts_with?('HocusPocus::')
+        super
+      end
+    end
+
+    module TemplateRendererExtension
+      def render_template(template, layout_name = nil, locals = {})
+        Thread.current[HocusPocus::Editor::VIEW_FILENAME] = template.virtual_path if @view.controller.try(:request).try(:format).try(:html?) && !@view.controller.class.name.starts_with?('HocusPocus::')
+        super
+      end
+    end
+
     class Railtie < ::Rails::Railtie #:nodoc:
       initializer 'hocus_pocus.editor' do |app|
         ActiveSupport.on_load(:after_initialize) do
@@ -18,23 +32,8 @@ module HocusPocus
 
         ActiveSupport.on_load(:action_view) do
           if HocusPocus.config.enable_editor
-            module ::ActionView
-              class PartialRenderer
-                def render_partial_with_filename_caching
-                  (Thread.current[HocusPocus::Editor::PARTIAL_FILENAMES] ||= []) << @template unless @view.controller.class.name.starts_with?('HocusPocus::')
-                  render_partial_without_filename_caching
-                end
-                alias_method_chain :render_partial, :filename_caching
-              end
-
-              class TemplateRenderer
-                def render_template_with_filename_caching(template, layout_name = nil, locals = {})
-                  Thread.current[HocusPocus::Editor::VIEW_FILENAME] = template.virtual_path if @view.controller.try(:request).try(:format).try(:html?) && !@view.controller.class.name.starts_with?('HocusPocus::')
-                  render_template_without_filename_caching template, layout_name, locals
-                end
-                alias_method_chain :render_template, :filename_caching
-              end
-            end
+            ::ActionView::PartialRenderer.send :prepend, HocusPocus::Editor::PartialRendererExtension
+            ::ActionView::TemplateRenderer.send :prepend, HocusPocus::Editor::TemplateRendererExtension
           end
         end
       end

data/engines/generator/app/controllers/hocus_pocus/generator/generator_controller.rb

@@ -18,7 +18,8 @@ module HocusPocus
       # XHR
       def scaffold
         #FIXME validate params
-        p options = params[:attr].select {|_k, v| v.present?}.map {|k, v| "#{v}:#{params[:type][k]}"}
+        options = []
+        params[:attr].select {|_k, v| v.present?}.each {|k, v| options << "#{v}:#{params[:type][k]}"}
         execute_scaffold params[:name].dup, options
         migrate
         #FIXME notice doesn't appear?
@@ -39,7 +40,12 @@ module HocusPocus
 
       # `rake db:migrate`
       def migrate
-        ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        if defined? ActiveRecord::MigrationContext  # >= 5.2
+          ActiveRecord::Base.connection.migration_context.up(ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        else
+          ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        end
+
         if ActiveRecord::Base.schema_format == :ruby
           File.open(ENV['SCHEMA'] || "#{Rails.root}/db/schema.rb", "w") do |file|
             ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)

data/engines/generator/app/views/hocus_pocus/generator/generator/index.html.erb

@@ -3,6 +3,7 @@
     <title>generator</title>
     <%= stylesheet_link_tag 'generator' %>
     <%= javascript_include_tag 'application' %>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
     <%= csrf_meta_tags %>
     <script type="text/javascript">
       $(document).on('click', '#add_attr_type', function() {

data/engines/generator/lib/hocus_pocus/generator/engine.rb

@@ -2,6 +2,11 @@ module HocusPocus
   module Generator
     class Engine < ::Rails::Engine
       isolate_namespace HocusPocus::Generator
+      initializer 'hocus_pocus.recorder.add middleware' do |app|
+        if HocusPocus.config.enable_generator
+          config.assets.precompile += %w(generator.css)
+        end
+      end
     end
   end
 end

data/engines/recorder/lib/hocus_pocus/recorder/engine.rb

@@ -8,6 +8,8 @@ module HocusPocus
       initializer 'hocus_pocus.recorder.add middleware' do |app|
         if HocusPocus.config.enable_scenario_recorder
           app.middleware.insert HocusPocus::Middleware, HocusPocus::Recorder::Middleware
+
+          app.config.assets.precompile += %w(recorder.js recorder.css)
         end
       end
     end

data/engines/recorder/lib/hocus_pocus/recorder/middleware.rb

@@ -10,11 +10,23 @@ module HocusPocus
       end
 
       def call(env)
-        @app.call(env).tap do |status, headers, body|
-          if body.is_a?(ActionDispatch::Response) && body.request.format.html? && (body.request.path !~ %r[^/*hocus_pocus/])
-            body.body = insert_text body.body, :before, /<\/head>/i, %Q[<script src="/assets/recorder.js"></script>]
-            body.body = insert_text body.body, :after, /<div id="#{HocusPocus::CONTAINER}" .*?>/i, %Q[#{spec_link}#{spec}]
+        status, headers, body = @app.call env
+
+        if headers && headers['Content-Type']&.include?('text/html') && (env['REQUEST_PATH'] !~ %r[^/*hocus_pocus/])
+          case body
+          when ActionDispatch::Response, ActionDispatch::Response::RackBody
+            body = body.body
+          when Array
+            body = body[0]
           end
+
+          body.sub!(/<\/head>/i) { %Q[<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script></head>] } unless body =~ /jquery(\.min)?\.js/
+          body.sub!(/<\/head>/i) { %Q[<script src="/assets/recorder.js"></script></head>] }
+          body.sub!(/<div id="#{HocusPocus::CONTAINER}" .*?>/i) { %Q[#{$~}#{spec_link}#{spec}] }
+
+          [status, headers, [body]]
+        else
+          [status, headers, body]
         end
       end
 

data/engines/recorder/lib/hocus_pocus/recorder/railtie.rb

@@ -17,7 +17,7 @@ module HocusPocus
         ActiveSupport.on_load(:action_controller) do
           if HocusPocus.config.enable_scenario_recorder
             class ::ActionController::Base
-              before_filter HocusPocus::Recorder::Filter
+              before_action HocusPocus::Recorder::Filter
             end
           end
         end

data/hocus_pocus.gemspec

@@ -12,14 +12,11 @@ Gem::Specification.new do |s|
   s.summary     = 'A magical Engine that casts a spell on your Rails 3.1 app'
   s.description = 'A magical Engine that casts a spell on your Rails 3.1 app'
 
-  s.rubyforge_project = 'hocus_pocus'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib', 'engines/generator/lib', 'engines/editor/lib', 'engines/recorder/lib', 'engines/command_line/lib']
 
-  s.extra_rdoc_files = ['README.rdoc']
   s.licenses = ['MIT']
 
   s.add_runtime_dependency 'nested_scaffold', ['>= 0.1.0']

data/lib/hocus_pocus/middleware.rb

@@ -9,10 +9,21 @@ module HocusPocus
     end
 
     def call(env)
-      @app.call(env).tap do |status, headers, body|
-        if body.is_a?(ActionDispatch::Response) && (body.request.path !~ %r[^/*hocus_pocus/])
-          body.body = insert_text body.body, :before, /<\/body>/i, %Q[<div id="#{HocusPocus::CONTAINER}" style="position:absolute; top:0; right: 0;"><link href="/assets/recorder.css" media="all" rel="stylesheet" type="text/css"></div>]
+      status, headers, body = @app.call env
+
+      if headers && headers['Content-Type']&.include?('text/html') && (env['REQUEST_PATH'] !~ %r[^/*hocus_pocus/])
+        case body
+        when ActionDispatch::Response, ActionDispatch::Response::RackBody
+          body = body.body
+        when Array
+          body = body[0]
         end
+
+        body.sub!(/<\/body>/i) { %Q[<div id="#{HocusPocus::CONTAINER}" style="position:absolute; top:0; right: 0;"><link href="/assets/recorder.css" media="all" rel="stylesheet" type="text/css"></div>#{$~}] }
+
+        [status, headers, [body]]
+      else
+        [status, headers, body]
       end
     end
   end

data/lib/hocus_pocus/version.rb

@@ -1,3 +1,3 @@
 module HocusPocus
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: hocus_pocus
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-20 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nested_scaffold
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
 description: A magical Engine that casts a spell on your Rails 3.1 app
@@ -29,16 +29,25 @@ email:
 - ronnie@dio.jp
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- .document
-- .gitignore
+- ".document"
+- ".gitignore"
 - CHANGELOG
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
+- doc/assets/hp_adding_post_comments_path.png
+- doc/assets/hp_adding_users_path.png
+- doc/assets/hp_before_steak.png
+- doc/assets/hp_editing_partial.png
+- doc/assets/hp_editing_show.png
+- doc/assets/hp_localhost_3000.png
+- doc/assets/hp_nested_scaffold.png
+- doc/assets/hp_scaffold.png
+- doc/assets/hp_scaffolded.png
+- doc/assets/hp_steak.png
 - engines/command_line/app/controllers/hocus_pocus/command_line/command_line_controller.rb
 - engines/command_line/app/views/hocus_pocus/command_line/command_line/execute.js.erb
 - engines/command_line/config/routes.rb
@@ -83,8 +92,6 @@ files:
 - lib/hocus_pocus/railtie.rb
 - lib/hocus_pocus/version.rb
 - lib/tasks/hocus_pocus_tasks.rake
-- test/helper.rb
-- test/test_hocus_pocus.rb
 homepage: https://github.com/amatsuda/hocus_pocus
 licenses:
 - MIT
@@ -99,20 +106,17 @@ require_paths:
 - engines/command_line/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: hocus_pocus
-rubygems_version: 2.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A magical Engine that casts a spell on your Rails 3.1 app
-test_files:
-- test/helper.rb
-- test/test_hocus_pocus.rb
+test_files: []

data/README.rdoc

@@ -1,20 +0,0 @@
-= hocus_pocus
-
-See this blog post for the details
-http://blog.dio.jp/2010/12/21/hocus_pocus
-
-
-== Questions, Feedback
-
-Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda)  ☇3☇3☇3
-
-
-== Contributing to hocus_pocus
-
-* Fork, fix, then send me a pull request.
-
-
-== Copyright
-
-Copyright (c) 2010-2011 Akira Matsuda. See MIT-LICENSE for
-further details.

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'hocus_pocus'
-
-class Test::Unit::TestCase
-end

data/test/test_hocus_pocus.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestHocusPocus < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end