yawl_rails 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23c0a0837ced1dd8761391411dc7d4da06e8070e
+  data.tar.gz: db1f00918971dd80826e0c17b0486b485c15b4b1
+SHA512:
+  metadata.gz: 303eeab3010e199135534f336bb0eb5ba7bf48aedb8b15a8e22ba68da0fd4af1894b4e0eef481adad2c94230043edcaa0c46074e5bb0aa471a517c523a1e1ac5
+  data.tar.gz: f40d303a4921fd3387461bbb13b66727be2c985937ac7b4f1ac9f4cc152a14ec944a909b475a79357114b0cb461b2c53f522d72ee3d815dda944615d673f322a

data/README.md

@@ -4,8 +4,30 @@ This is the UI and Rails integration component of [yawl](https://github.com/rica
 
 ## Migrations
 
-`yawl_rails` automatically sets the schema file to be in sql format because of the `json` column used in `yawl`
+The engine should automatically hook into Rails and allow you to *just* run `rake db:migrate`
+
+## Routing
+
+I like to mount the engine at the root, so the following would work but you can also mount it anywhere you see fit.
 
 ```
-config.active_record.schema_format = :sql
+mount YawlRails::Engine, at: "/"
 ```
+
+## Config
+
+Extra config variables added:
+
+* `Yawl::Config.pagination_per_page`: Number of processes to list per page
+
+## Templates
+
+It's currently setup so that you need to use haml in `yawl_rails` and assumes that you want to share your layout with it to maintain an integrated look.  One caveat is that it's using bootstrap 2--*maybe a rails4 only engine + bootstrap 3 is in the future?*.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/app/controllers/yawl_rails/processes_controller.rb

@@ -2,8 +2,11 @@ require_dependency "yawl_rails/application_controller"
 
 module YawlRails
   class ProcessesController < ApplicationController
+    before_filter :load_process, only: [:show, :restart, :steps]
+
     def index
-      @processes = ::Yawl::Process.order(:id).reverse
+      page = (params[:page] || 1).to_i
+      @processes = ::Yawl::Process.pagination_dataset.order(:id).reverse.paginate(page, Yawl::Config.pagination_per_page)
 
       respond_to do |format|
         format.html
@@ -12,8 +15,6 @@ module YawlRails
     end
 
     def show
-      @process = ::Yawl::Process.first(:id => params[:id])
-
       respond_to do |format|
         format.html
         format.json { render :json => @process.to_hash.merge(:steps => @process.steps.map(&:to_hash)) }
@@ -21,7 +22,6 @@ module YawlRails
     end
 
     def restart
-      @process = ::Yawl::Process.first(:id => params[:id])
       @process.start_first_unfinished_step
 
       respond_to do |format|
@@ -31,12 +31,23 @@ module YawlRails
     end
 
     def steps
-      @process = ::Yawl::Process.first(:id => params[:id])
-
       respond_to do |format|
         format.html { render :partial => "step_rows" }
         format.json { render :json => @process.to_hash.merge(:steps => @process.steps.map(&:to_hash)) }
       end
     end
+
+    protected
+
+    def load_process
+      @process = ::Yawl::Process.first(:name => params[:id])
+      if @process.nil?
+        respond_to do |format|
+          format.html { render :text => "Process not found", :status => 404 }
+          format.json { render :json => { "error" => "Process not found" }, :status => 404 }
+        end
+        false
+      end
+    end
   end
 end

data/app/controllers/yawl_rails/steps_controller.rb

@@ -3,7 +3,7 @@ require_dependency "yawl_rails/application_controller"
 module YawlRails
   class StepsController < ApplicationController
     def show
-      @process = ::Yawl::Process.first(:id => params[:process_id])
+      @process = ::Yawl::Process.first(:name => params[:process_id])
       @step = @process.steps_dataset.first(:id => params[:id])
 
       respond_to do |format|

data/app/views/yawl_rails/processes/_pagination.html.haml

@@ -0,0 +1,5 @@
+.pagination
+  %ul
+    - objects.page_range.each do |page|
+      %li
+        %a{:href => "?page=#{page}", :class => (objects.current_page == page ? 'active' : '')}= page

data/app/views/yawl_rails/processes/_show_inline_js.html.haml

@@ -1,5 +1,5 @@
 = javascript_include_tag "yawl_rails/processes"
 
 :javascript
-  YawlProcess.url = "#{steps_yawl_process_path(@process.id)}";
+  YawlProcess.url = "#{steps_yawl_process_path(@process.name)}";
   YawlProcess.init();

data/app/views/yawl_rails/processes/_step_rows.html.haml

@@ -1,10 +1,10 @@
 - @process.steps.each do |step|
   %tr.step{:id => "step-#{step.seq}"}
-    %td= link_to step.seq, yawl_process_step_path(@process.id, step.id)
+    %td= link_to step.seq, yawl_process_step_path(@process.name, step.id)
     %td
       = step.name
       - if step.state == "failed" && @process.current?
-        = link_to "<i class='icon-refresh icon-white'></i> Retry".html_safe, restart_yawl_process_path(@process.id), :method => :post, :class => "btn btn-mini btn-primary"
+        = link_to "<i class='icon-refresh icon-white'></i> Retry".html_safe, restart_yawl_process_path(@process.name), :method => :post, :class => "btn btn-mini btn-primary"
     %td.step-state= step.state
     %td= step.attempts.count
     %td

data/app/views/yawl_rails/processes/index.html.haml

@@ -13,7 +13,10 @@
     %tbody
       - @processes.each do |p|
         %tr{:id => "process-#{p.name}"}
-          %td= link_to p.name, yawl_process_path(p.id)
+          %td= link_to p.name, yawl_process_path(p.name)
           %td= p.desired_state
           %td= p.state
           %td= p.created_at
+
+- if @processes.page_count > 1
+  = render 'pagination', objects: @processes

data/app/views/yawl_rails/processes/show.html.haml

@@ -13,6 +13,7 @@
   %dt State
   %dd= @process.state
 
+= render 'process_extra_info'
 
 .progress.progress-striped.active
   .bar#process-progress{:style => "width: 0%;"}

data/app/views/yawl_rails/steps/show.html.haml

@@ -1,4 +1,4 @@
-%h1= link_to "Process #{@process.name}", yawl_process_path(@process.id)
+%h1= link_to "Process #{@process.name}", yawl_process_path(@process.name)
 
 %h2= "Step #{@step.seq}: #{@step.name}"
 

data/config/routes.rb

@@ -1,6 +1,6 @@
 YawlRails::Engine.routes.draw do
   scope as: 'yawl' do
-    resources :processes, :only => [:index, :show] do
+    resources :processes, :only => [:index, :show], :constraints => {:id => /[^\s]+/} do
       member do
         post :restart
         get :steps

data/lib/yawl/pagination.rb

@@ -0,0 +1,21 @@
+module Yawl
+  module Config
+    mattr_accessor :pagination_per_page
+
+    DEFAULT_PAGINATION_PER_PAGE = 20
+  end
+
+  module Pagination
+    module ClassMethods
+      def pagination_dataset
+        dataset.extension(:pagination)
+      end
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+  end
+end
+
+::Yawl::Process.send(:include, Yawl::Pagination)

data/lib/yawl_rails/engine.rb

@@ -11,12 +11,23 @@ module YawlRails
 
     initializer "yawl_rails.append_migrations" do |app|
       unless app.root.to_s.match root.to_s
-        app.config.paths["db/migrate"] += config.paths["db/migrate"].expanded
+        if Rails::VERSION::MAJOR >= 4
+          config.paths["db/migrate"].expanded.each do |expanded_path|
+            app.config.paths["db/migrate"] << expanded_path
+          end
+        else
+          app.config.paths["db/migrate"] += config.paths["db/migrate"].expanded
+        end
       end
     end
 
     initializer "yawl_rails.setup_yawl" do |app|
       require "yawl/rails"
     end
+
+    initializer "yawl_rails.setup_pagination" do |app|
+      require "yawl/pagination"
+      Yawl::Config.pagination_per_page ||= Yawl::Config::DEFAULT_PAGINATION_PER_PAGE
+    end
   end
 end

data/lib/yawl_rails/version.rb

@@ -1,3 +1,3 @@
 module YawlRails
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/controllers/yawl_rails/processes_controller_spec.rb

@@ -19,5 +19,23 @@ module YawlRails
         assigns(:processes).map(&:id).should match_array([@p2, @p1])
       end
     end
+
+    describe "GET #show" do
+      it "shows the process" do
+        @p1 = ::Yawl::Process.insert(:desired_state => "test1", :name => "p1-test")
+
+        get :show, id: "p1-test", use_route: :yawl_rails
+
+        expect(response).to be_success
+        expect(response).to render_template("show")
+      end
+
+      it "returns a 404 for an unknown process" do
+        get :show, id: "unknown-test", use_route: :yawl_rails
+
+        expect(response.code).to eq("404")
+        expect(response).to_not render_template("show")
+      end
+    end
   end
 end

data/spec/controllers/yawl_rails/steps_controller_spec.rb

@@ -3,20 +3,21 @@ require 'spec_helper'
 module YawlRails
   describe StepsController do
     before(:each) do
-      @process_id = Yawl::Process.insert(:desired_state => "testing")
+      @process_name = "p1-123"
+      @process_id = Yawl::Process.insert(:desired_state => "testing", :name => @process_name)
       @step_id = Yawl::Step.insert(:process_id => @process_id, :name => "step1", :seq => 1)
     end
 
     describe "GET #show" do
       it "renders the right template" do
-        get :show, :process_id => @process_id, :id => @step_id, :use_route => :yawl_rails
+        get :show, :process_id => @process_name, :id => @step_id, :use_route => :yawl_rails
 
         expect(response).to be_success
         expect(response).to render_template("show")
       end
 
       it "assigns @step" do
-        get :show, :process_id => @process_id, :id => @step_id, :use_route => :yawl_rails
+        get :show, :process_id => @process_name, :id => @step_id, :use_route => :yawl_rails
 
         assigns(:step).id.should eq(@step_id)
       end

data/spec/features/yawl_rails/processes/list_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+feature "List Processes" do
+  scenario "does not contain pagination" do
+    @p1 = ::Yawl::Process.insert(:name => "p1", :desired_state => "test1")
+
+    visit yawl_rails.yawl_processes_path
+    expect(page).to_not have_selector(".pagination")
+  end
+
+  scenario "contains pagination" do
+    @p1 = ::Yawl::Process.insert(:name => "p1", :desired_state => "test1")
+    @p2 = ::Yawl::Process.insert(:name => "p2", :desired_state => "test1")
+    @p3 = ::Yawl::Process.insert(:name => "p3", :desired_state => "test1")
+
+    visit yawl_rails.yawl_processes_path
+    expect(page).to have_selector(".pagination")
+    expect(find(".pagination")).to have_link("1", href: "?page=1")
+    expect(find(".pagination")).to have_link("2", href: "?page=2")
+    expect(find(".pagination")).to_not have_link("3", href: "?page=3")
+    expect(find(".pagination")).to_not have_link("0", href: "?page=0")
+  end
+
+  scenario "doesn't blow up if given a bad page number" do
+    @p1 = ::Yawl::Process.insert(:name => "p1", :desired_state => "test1")
+    @p2 = ::Yawl::Process.insert(:name => "p2", :desired_state => "test1")
+    @p3 = ::Yawl::Process.insert(:name => "p3", :desired_state => "test1")
+
+    visit yawl_rails.yawl_processes_path + "?page=3"
+    expect(page).to have_selector(".pagination")
+    expect(find(".pagination")).to_not have_link("3", href: "?page=3")
+  end
+end

data/spec/features/yawl_rails/processes/show_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+feature "Process Page" do
+  background do
+    @p1_id = ::Yawl::Process.insert(:name => "p1", :desired_state => "test1")
+  end
+
+  scenario "javascript uses correct process url" do
+    visit yawl_rails.yawl_process_path('p1')
+    expect(page.source).to include("/yawl_rails/processes/p1/steps")
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,15 @@
 ENV['RAILS_ENV'] ||= 'test'
-ENV['DATABASE_URL'] = 'postgres://localhost/yawl-rails-test'
+ENV['DATABASE_URL'] ||= 'postgres://localhost/yawl-rails-test'
 
 require File.expand_path("../test_app/config/environment.rb",  __FILE__)
 require 'rspec/rails'
 require 'rspec/autorun'
 
+require 'capybara/rails'
+require 'capybara/rspec'
+
+Yawl::Config.pagination_per_page = 2
+
 Rails.backtrace_cleaner.remove_silencers!
 
 # Load support files

data/yawl_rails.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "pg"
   spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "capybara"
 end

metadata

@@ -1,94 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: yawl_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Ricardo Chimal, Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yawl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Rails UI for YAWL
@@ -99,7 +102,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,6 +113,8 @@ files:
 - app/controllers/yawl_rails/steps_controller.rb
 - app/helpers/yawl_rails/application_helper.rb
 - app/helpers/yawl_rails/processes_helper.rb
+- app/views/yawl_rails/processes/_pagination.html.haml
+- app/views/yawl_rails/processes/_process_extra_info.html.haml
 - app/views/yawl_rails/processes/_show_inline_js.html.haml
 - app/views/yawl_rails/processes/_step_rows.html.haml
 - app/views/yawl_rails/processes/index.html.haml
@@ -119,6 +124,7 @@ files:
 - config/routes.rb
 - db/migrate/20140225002136_setup_yawl.rb
 - lib/tasks/yawl_rails_tasks.rake
+- lib/yawl/pagination.rb
 - lib/yawl/process_active_record.rb
 - lib/yawl/rails.rb
 - lib/yawl_rails.rb
@@ -126,6 +132,8 @@ files:
 - lib/yawl_rails/version.rb
 - spec/controllers/yawl_rails/processes_controller_spec.rb
 - spec/controllers/yawl_rails/steps_controller_spec.rb
+- spec/features/yawl_rails/processes/list_spec.rb
+- spec/features/yawl_rails/processes/show_spec.rb
 - spec/helpers/yawl_rails/processes_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_app/README.rdoc
@@ -170,37 +178,32 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3973182591231445544
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3973182591231445544
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rails UI for YAWL
 test_files:
 - spec/controllers/yawl_rails/processes_controller_spec.rb
 - spec/controllers/yawl_rails/steps_controller_spec.rb
+- spec/features/yawl_rails/processes/list_spec.rb
+- spec/features/yawl_rails/processes/show_spec.rb
 - spec/helpers/yawl_rails/processes_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_app/README.rdoc