rtml 1.2.2 → 2.0.0.alpha.1

data/rails_generators/rtml/templates/db/migrate/20100108163703_create_rtml_dom_elements.rb

@@ -0,0 +1,16 @@
+class CreateRtmlDomElements < ActiveRecord::Migration
+  def self.up
+    create_table :rtml_dom_elements do |t|
+      t.string :name
+      t.string :type, :default => 'Rtml::Dom::Element'
+
+      t.references :parent
+      t.references :document
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :rtml_dom_elements
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100108163827_create_rtml_dom_properties.rb

@@ -0,0 +1,16 @@
+class CreateRtmlDomProperties < ActiveRecord::Migration
+  def self.up
+    create_table :rtml_dom_properties do |t|
+      t.string :name
+      t.text :value
+      t.string :type
+
+      t.references :element
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :rtml_dom_properties
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100108165127_create_rtml_documents.rb

@@ -0,0 +1,15 @@
+class CreateRtmlDocuments < ActiveRecord::Migration
+  def self.up
+    create_table :rtml_documents do |t|
+      t.string :name
+      t.text :description
+      t.boolean :cache_on_terminal
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :rtml_documents
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100110060124_create_rtml_instructions.rb

@@ -0,0 +1,15 @@
+class CreateRtmlInstructions < ActiveRecord::Migration
+  def self.up
+    create_table :rtml_instructions do |t|
+      t.string :name
+      t.text :arguments
+
+      t.references :source, :polymorphic => true
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :rtml_instructions
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100110071920_add_parent_id_to_rtml_instructions.rb

@@ -0,0 +1,9 @@
+class AddParentIdToRtmlInstructions < ActiveRecord::Migration
+  def self.up
+    add_column :rtml_instructions, :parent_id, :integer
+  end
+
+  def self.down
+    remove_column :rtml_instructions, :parent_id
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100113131401_add_options_to_properties.rb

@@ -0,0 +1,9 @@
+class AddOptionsToProperties < ActiveRecord::Migration
+  def self.up
+    add_column :rtml_dom_properties, :options, :text
+  end
+
+  def self.down
+    remove_column :rtml_dom_properties, :options
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100127173146_add_parent_type_to_rtml_dom_elements.rb

@@ -0,0 +1,9 @@
+class AddParentTypeToRtmlDomElements < ActiveRecord::Migration
+  def self.up
+    add_column :rtml_dom_elements, :parent_type, :string
+  end
+
+  def self.down
+    remove_column :rtml_dom_elements, :parent_type
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100208114234_create_rtml_states.rb

@@ -0,0 +1,20 @@
+class CreateRtmlStates < ActiveRecord::Migration
+  def self.up
+    create_table :rtml_states do |t|
+      t.string   :itid
+      t.string   :model
+      t.string   :serial_number
+      t.string   :os
+      t.string   :part_number
+      t.datetime :datetime
+      t.datetime :datetime_start
+      t.text     :other_data
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :rtml_states
+  end
+end

data/rails_generators/rtml/templates/db/migrate/20100303021609_add_x_and_y_to_rtml_instructions.rb

@@ -0,0 +1,12 @@
+class AddXAndYToRtmlInstructions < ActiveRecord::Migration
+  def self.up
+    # For GUI representation.
+    add_column :rtml_instructions, :x, :integer, :default => 0
+    add_column :rtml_instructions, :y, :integer, :default => 0
+  end
+
+  def self.down
+    remove_column :rtml_instructions, :y
+    remove_column :rtml_instructions, :x
+  end
+end

data/rails_generators/rtml/templates/lib/tasks/rtml.rake

@@ -0,0 +1,65 @@
+begin
+  require 'spec/rake/spectask'
+rescue MissingSourceFile
+end
+
+# This is a tiny bit faster than the bootstrapper because we can skip some of the dependencies, which matters a lot more
+# in potentially-often-run rake tasks.
+module Rtml; module WidgetCore; end; end
+require 'rtml'
+unless defined?(Rtml::Widget)
+  require 'rtml/widget_core/class_methods'
+  require 'rtml/widget'
+end
+
+namespace :rtml do
+  desc "Generates RTML rdoc documentation in ./doc/rtml"
+  Rake::RDocTask.new(:docs) do |rdoc|
+    target_dir = File.expand_path(".")
+    chdir Rtml.root
+    accessors = Rtml::Widget::RDOC_ACCESSORS.collect { |k,v| "#{k}=#{v}" }.join(",")
+    files = ['README.rdoc', 'History.txt', 'lib/**/*.rb', 'doc/**/*.rdoc', 'builtin/**/*.rb',
+             'rails_generators/*/*.rb']
+    rdoc.rdoc_files.add(files)
+    rdoc.main = 'README.rdoc'
+    rdoc.title = 'RubyTML 2.0 Documentation'
+    #rdoc.template = '/path/to/gems/allison-2.0/lib/allison'
+    rdoc.rdoc_dir = File.join(target_dir, 'doc/rtml')
+    rdoc.options << '--line-numbers' << '--inline-source' << '--accessor' << accessors
+  end
+
+  desc 'Migrates the database. In a regular Rails project, this is the same as db:migrate.'
+  task :migrate => 'db:migrate'
+
+  desc 'Destroys the database. In a regular Rails project, this is the same as db:destroy.'
+  task :destroy => 'db:destroy'
+
+  desc 'Resets the database. In a regular Rails project, this is the same as db:reset.'
+  task :reset => 'db:reset'
+
+  desc 'Sets up the database. In a regular Rails project, this is the same as db:migrate.'
+  task :setup => 'rtml:migrate'
+
+  desc 'Runs the entire RTML test suite in the context of your Rails application'
+  if defined?(Spec) && File.exist?(File.join($root_dir || RAILS_ROOT, 'spec'))
+    # some of this was blatantly stolen from the rakefile built by script/generate rspec. Yeah, I have no pride.
+    spec_prereq = File.exist?(File.join(RAILS_ROOT, 'config', 'database.yml')) ? "db:test:prepare" : 'noop'
+    Spec::Rake::SpecTask.new(:test => spec_prereq) do |t|
+      opts = "\"#{$root_dir || RAILS_ROOT}/spec/spec.opts\""
+      if File.exist?(opts)
+        t.spec_opts = ['--options', opts]
+      end
+      t.spec_files = FileList[File.join(Rtml.root, "spec/**/*_spec.rb")]
+    end
+  else
+    task :test do
+      puts "You need to have rspec, rspec-rails and webrat installed before you can run"
+      puts "in-place testing."
+      puts
+      puts "Make sure you've also run script/generate rspec, or you'll just see this"
+      puts "message again."
+    end
+  end
+
+  task :noop
+end

data/rails_generators/rtml_action/USAGE

@@ -0,0 +1,15 @@
+
+Usage (from your Rails application root):
+  ruby script/generate rtml_action controller_name action_name [screen_names]
+
+Screen names are optional, and an :idle screen will be generated if omitted.
+
+This generator builds a single RTML Action for your application. Note that
+the controller should extend RtmlController instead of ApplicationController,
+which is something this generator does NOT do for you.
+
+  * app/rtml_actions/[controller_path]/[action_name].rb
+    - the RTML Action itself
+
+  * app/views/[controller_path]/[action_name]/[screen_name].rtml.erb
+    - the view generated for this particular screen

data/rails_generators/rtml_action/rtml_action_generator.rb

@@ -0,0 +1,51 @@
+# This generator builds a single RTML Action for your application. Note that
+# the controller should extend RtmlController instead of ApplicationController,
+# which is something this generator does NOT do for you.
+#
+#   * app/rtml_actions/[controller_path]/[action_name].rb
+#     - the RTML Action itself
+#
+#   * app/views/[controller_path]/[action_name]/[screen_name].rtml.erb
+#     - the view generated for this particular screen
+# 
+# Usage (from your Rails application root):
+#
+#   ruby script/generate rtml_action controller_name action_name [screen_names]
+#
+# Screen names are optional, and an :idle screen will be generated if omitted.
+#
+class RtmlActionGenerator < Rails::Generator::NamedBase
+  attr_reader :action_name, :screen_names, :controller_path, :controller_name, :view_path, :action_path
+
+  def initialize(*a, &b)
+    super(*a, &b)
+    @controller_name = name.camelize
+    @controller_path = name.underscore
+    @action_name = args.shift
+    @screen_names = args.empty? ? ['idle'] : args
+    @view_path = "app/views/#{controller_path}/#{action_name}"
+    @action_path = "app/rtml_actions/#{controller_path}"
+  end
+
+  def manifest
+    record do |m|
+      m.directory action_path
+      m.directory view_path
+
+      m.template "action.erb", "#{action_path}/#{action_name}.rb"
+
+      screen_names.each do |screen_name|
+        m.template "view.erb",   "#{view_path}/#{screen_name}.rtml.erb", :assigns => { :screen_name => screen_name }
+      end
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+end

data/rails_generators/rtml_action/templates/action.erb

@@ -0,0 +1,12 @@
+Rtml.action :<%=action_name%>, :controller => :<%=controller_name%> do
+  expires_at { Time.at(0) }
+
+  screen :init, :idle do
+  end
+
+  <%screen_names.each do |screen_name|%>
+  screen :<%=screen_name%> do
+    display
+  end
+  <%end%>
+end

data/rails_generators/rtml_action/templates/view.erb

@@ -0,0 +1,2 @@
+<h1><%=controller_name%>#<%=action_name%>:<%=screen_name%></h1>
+Find me in <%=controller_path%>/<%=action_name%>/<%=screen_name%>.rtml.erb

data/rails_generators/widget/USAGE

@@ -0,0 +1,19 @@
+Description:
+  Generates an RTML Widget. See the Rtml::Widget class documentation for more
+information.
+
+Example:
+  ./script/generate widget Thing [entry_point_1 entry_point_2]
+
+  This will create:
+    lib/rtml/widgets/thing.rb
+
+    And Test::Unit tests:
+      test/unit/rtml/widgets/thing_test.rb
+
+    -or-
+
+    RSpec and/or Cucumber tests:
+      spec/rtml/widgets/thing_spec.rb
+      features/rtml/widgets/thing.feature
+    

data/rails_generators/widget/templates/default_widget.erb

@@ -0,0 +1,10 @@
+class Rtml::Widgets::<%=class_name%> < Rtml::Widget
+  affects :document, :element # all elements
+  entry_point <%=entry_points.collect { |ep| ":#{ep.underscore.gsub(/\//, '_')}" }.join(", ")%>
+
+<%entry_points.each do |entry_point| -%>
+  def <%=entry_point.underscore.gsub(/\//, '_')%>(name, options = { })
+
+  end
+<%end -%>
+end

data/rails_generators/widget/templates/default_widget.feature.erb

@@ -0,0 +1,11 @@
+Feature: <%=human_name.titleize%> Widget
+  In order to [business value]
+  As an RTML developer
+  I want to [action]
+
+  Scenario:
+    Given I have a new RTML document
+    When I follow these instructions:
+      | screen :init, :main          |
+      | screen :main                 |
+    Then the TML should resemble { :tml => :screen }

data/rails_generators/widget/templates/default_widget_spec.erb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'rtml/test/spec'
+
+describe Rtml::Widgets::<%=class_name%> do
+  before :each do
+    @doc = Rtml::Document.new
+  end
+
+  # add your own tests here
+  it "should be able to handle the truth" do
+    true.should == true
+  end
+end

data/rails_generators/widget/templates/default_widget_test.erb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class Rtml::Widgets::<%=class_name%>Test < ActiveSupport::TestCase
+  def setup
+    @doc = Rtml::Document.new
+    @doc.setup_default_document
+  end
+
+  # add your own tests here
+  test "should be able to handle the truth" do
+    assert true
+  end
+end

data/rails_generators/widget/widget_generator.rb

@@ -0,0 +1,48 @@
+# Description:
+#   Generates an RTML Widget. See the Rtml::Widget class documentation for more
+# information.
+#
+# Example:
+#   ./script/generate widget Thing [entry_point_1 entry_point_2]
+#
+#   This will create:
+#     lib/rtml/widgets/thing.rb
+#
+#     And Test::Unit tests:
+#       test/unit/rtml/widgets/thing_test.rb
+#
+#     -or-
+#
+#     RSpec and/or Cucumber tests:
+#       spec/rtml/widgets/thing_spec.rb
+#       features/rtml/widgets/thing.feature
+#     
+class WidgetGenerator < Rails::Generator::NamedBase
+  attr_reader :entry_points, :human_name
+
+  def manifest
+    @entry_points = args.dup
+    @entry_points << class_name.underscore.sub(/^.*\//, '') if @entry_points.empty?
+    @human_name = file_name.humanize
+
+    record do |m|
+      m.directory "lib/rtml/widgets"
+      m.template 'default_widget.erb', "lib/rtml/widgets/#{file_name}.rb"
+
+      if File.directory?(File.join(RAILS_ROOT, "spec")) || File.directory?(File.join(RAILS_ROOT, "features"))
+        if File.directory?(File.join(RAILS_ROOT, "spec"))
+          m.directory "spec/rtml/widgets"
+          m.template "default_widget_spec.erb", "spec/rtml/widgets/#{file_name}_spec.rb"
+        end
+
+        if File.directory?(File.join(RAILS_ROOT, "features"))
+          m.directory "features/rtml/widgets"
+          m.template "default_widget.feature.erb", "features/rtml/widgets/#{file_name}.feature"
+        end
+      else # we only need Rails unit tests neither cucumber nor rspec is available.
+        m.directory "test/unit/rtml/widgets"
+        m.template 'default_widget_test.erb', "test/unit/rtml/widgets/#{file_name}_test.rb"
+      end
+    end
+  end
+end

data/script/console

@@ -5,6 +5,9 @@ irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 libs =  " -r irb/completion"
 # Perhaps use a console_lib to store any extra methods I may want available in the cosole
 # libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rtml.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../rails/init.rb'}"
+libs << " -r spec/spec_helper"
+#libs << " -r spec/support/test_database"
+
 puts "Loading rtml gem"
-exec "#{irb} #{libs} --simple-prompt"
+exec "#{irb} #{libs} --simple-prompt"

data/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../spec/support/rails',  __FILE__)
+require 'commands/server'

data/spec/controllers/inherited_controller_spec.rb

@@ -0,0 +1,19 @@
+require File.join(__FILE__.gsub(/(.*)?\/spec\/.*$/, '\1'), 'spec/spec_helper')
+
+describe InheritedController do
+  it "should render #get_state from parent" do
+    get :index, :format => :rtml
+    #puts response.body
+    response.should_not contain_errors
+    response.template.template_format.should == :rtml
+    response.should have_selector(:tml)
+  end
+
+  it "should render #index from child" do
+    get :index, :format => :rtml, :ignore_state => true
+    #puts response.body
+    response.should_not contain_errors
+    response.template.template_format.should == :rtml
+    response.should have_selector(:screen, :id => "overridden")
+  end
+end