shway 3.0

data/lib/shway/presenters/shway_model_presenter.rb

@@ -0,0 +1,10 @@
+class ShwayModelPresenter < ShwayPresenter 
+
+  def initialize(template, model, options={})
+    super(template, options)
+    model_name = self.class.name.chomp('Presenter').underscore  # model_name = 'deployment'
+    self.class.send :attr_accessor, model_name.intern           # self.class.send :attr_accessor, :deployment
+    self.send "#{model_name}=".intern, model                    # self.send "deployment=".itern, model
+  end
+  
+end    

data/lib/shway/presenters/shway_presenter.rb

@@ -0,0 +1,184 @@
+class ShwayPresenter
+
+  attr_reader :template, :options
+
+  def initialize(template, options={})
+    if template.kind_of? ShwayPresenter
+      template = template.template 
+    elsif template.kind_of? ActionController::Base
+      template = template.response.template
+    end
+    raise "must supply a template to #{self.class.name}.new, not #{template.class.name}" unless template.kind_of?(ActionView::Base)
+    @template = template
+    @options  = {}
+    setup_options options
+  end
+
+  def render(name=:default, *args)
+    unless name.kind_of?(Symbol)
+      args.unshift name
+      name = :default
+    end
+    _start
+    raise "#{self.class.name} has no renderer defined for :#{name}. To create one, use: renderer :#{name} do ... end" unless self.respond_to? "render_#{name}_presenter"
+    send "render_#{name}_presenter", 'called_from_render', *args
+    _finish
+  end
+
+  def r(string=nil, options={}, &block)
+    raise "#{self.class.name} rendering has not been started. Be sure you call render(:name)" unless @result
+    string, options = nil, string if string.kind_of? Hash
+    string = capture(&block) if block
+    @result << render_to_string(:partial => options[:partial], :locals => options[:locals]) if options[:partial]
+    @result << string if string
+  end
+  
+  def self.renderer_with_method(name, options={}, &block)
+    options, block = {}, options if options.is_a? Proc
+    options[:method] = true
+    renderer(name, options, &block)
+  end
+
+  def self.renderer(name, options={}, &block)
+    options, block = {}, options if options.is_a? Proc
+    method_name = "render_#{name}_presenter"
+    define_method "_#{method_name}", block
+    
+    arg_string = arg_string_for_renderer_block block
+    arg_string_with_comma = arg_string.blank? ? '' : ", #{arg_string}"
+    arg_string_without_nils = arg_string.gsub '=nil', ''
+    arg_string_with_comma_without_nils = arg_string_without_nils.blank? ? nil : ", #{arg_string_without_nils}"
+    
+    presenter_string = <<-CLASS_EVAL
+      def render_#{name}_presenter(render_check#{arg_string_with_comma})
+        raise "Don't call \\"#{method_name}\\" directly. Instead use render(:#{name})" unless render_check == 'called_from_render'
+        _#{method_name}(#{arg_string_without_nils})
+      end
+    CLASS_EVAL
+    class_eval presenter_string
+    #this is optional, since it pollutes the presenter with potentially duplicate method names. But it sure feels nice to use.
+    if options[:method]
+      presenter_method_string = <<-CLASS_EVAL
+        def #{name}(#{arg_string})
+          render(:#{name}#{arg_string_with_comma_without_nils})
+        end
+      CLASS_EVAL
+      class_eval presenter_method_string
+    end
+  end
+
+  def self.arg_string_for_renderer_block(block)
+    s = []
+    #TODO look into a better way to actually do this. Like maybe looping and adding the [ and ] chars where necessary.
+    splat = block.arity < 0
+    argument_count = block.arity.abs
+    argument_count -= 1 if splat
+    argument_count.times do |number|
+      s << "arg_#{number+1}=nil"
+    end
+    s << "*arg_splat" if splat
+    s.join ','
+  end
+
+  #TODO make sure I actually need this. put it back if so.
+  # def render_to_string(partial)
+  #   template.controller.send :render_to_string, partial
+  # end
+
+  def shared_instance_variable(var_name_symbol)
+    template.controller.instance_variable_get(var_name_symbol) || template.instance_variable_get(var_name_symbol)
+  end
+
+  #for any options that match methods on this presenter, set them on this presenter. Merge the remaining options onto any existing options.
+  def setup_options(options={})
+    return if options.blank?
+    options = options.clone
+    options.keys.each do |key|
+      setter = "#{key}=".intern
+      #if there is a setter, call it
+      if self.respond_to? setter
+        self.send setter, options.delete(key) 
+        next
+      end
+      #if there is a no setter, but there is a method, call it with *args
+      #TODO write some tests for varying method signatures
+      if self.respond_to?(key) && (method(key).arity == 1 || method(key).arity <= -2)
+        self.send key, *options.delete(key) 
+        next
+      end
+    end
+    self.options.merge! options
+  end
+
+  ## accessors/cache for model presenters. potentially move this somewhere else.
+  def model_presenters
+    @model_presenters ||= {}
+  end
+    
+  #NOTE: if the model might ever be nil, you need to supply :model_class, and the model presenter should be able to handle the nil model.
+  def presenter_for(model, model_class=nil, options={}, &block)
+    model_class, options = options, model_class if model_class.is_a? Hash
+    model_class ||= options.delete :model_class
+    #presenters for nil objects end up being cached with the model_class as their key
+    presenter = model_presenters[model || model_class] ||= presenter_class_for(model || model_class).new(self, model, options)
+    yield presenter if block
+    presenter
+  end
+  
+  def presenters_for(models, model_class=nil, options={}, &block)
+    presenters = []
+    models.each do |model|
+      presenters << presenter_for(model, model_class, options, &block)
+    end
+    presenters
+  end
+  
+  #you can pass a model or a model_class here
+  def presenter_class_for(model)
+    @presenter_classes_for_models ||= {}
+    model_class = model.is_a?(Class) ? model : model.class
+    if @presenter_classes_for_models[model_class]
+      @presenter_classes_for_models[model_class]
+    else
+      presenter_class_name = "#{model_class.to_s.split('::').last}Presenter"
+      presenter_class = Module.const_get(presenter_class_name)
+      @presenter_classes_for_models[model_class] = presenter_class
+      presenter_class
+    end
+  end
+  
+  #this prevents redcloth's t method from winning over the I18N's t method
+  def t(*args)
+    template.t(*args)
+  end
+
+  private
+  
+    def _start
+      @results ||= []
+      @results << []
+      @result = @results.last
+    end
+
+    def _finish
+      html = @result.join("\n")
+      @results.pop
+      @result = @results.last
+      html
+    end
+
+    def method_missing(method, *args, &block)
+      raise "No template was given to #{self.class.name} and the method '#{method}' was not found. Either define it or supply a template if it is a rails method (eg link_to)" unless template
+      #NOTE: ActionView::Base doesn't "respond_to?" :h since it is a method_missing thing with no asociated respond_to? implementation.
+      #      it also doesn't respond to :method_javascript_function. I'm sure there will be more of these. Is there a list somewhere?
+      #TODO: Put these extra methods in a config or at least an array at some point
+      if template.respond_to?(method) || method == :h || method == :method_javascript_function
+        template.__send__(method, *args, &block)
+      elsif template.controller.respond_to?(method)
+        template.controller.__send__(method, *args, &block)
+      else
+        super
+      end
+    end
+
+end

data/lib/shway/test/shway_test_helper.rb

@@ -0,0 +1,78 @@
+module ShwayTestHelper
+
+  def assert_ajax_redirected_to(url)
+    url = @request.referer if url == :back
+    assert_displayed %{window.location.href = "#{url}"}, :rjs => true
+  end
+
+  def assert_attributes_displayed(model, *attributes)
+    # TODO look into preventing the attributes from being nil
+    attributes.compact.each do |attribute|
+      value = model
+      #this will walk the attributes as long as they resolve to a value, not a collection or model. 
+      atts = []
+      attribute.to_s.split('.').each do |att|
+        atts << att
+        raise "the model doesn't appear to have the attribute you specified (#{attribute.inspect}) (specifically: #{atts.join('.')})" unless value.respond_to? att
+        value = value.send att
+      end
+      # puts "**testing for attribute: #{attribute}=#{value}"
+      if value.kind_of?(ActiveRecord::Base) || value.kind_of?(Array)
+        raise "assert_attributes_displayed can only test attributes, not associations (#{attribute.inspect} == #{value}) "
+      end
+      assert_displayed value, :message => %{The value (#{value}) for the attribute "#{attribute}" was not found in the response body.} unless value.blank? || attribute.blank? 
+    end
+  end
+  alias_method :assert_attribute_displayed, :assert_attributes_displayed
+
+  def assert_attributes_displayed_for_collection(collection,  *attributes)
+    collection.each do |model|
+      assert_attributes_displayed(model, *attributes)
+    end
+  end
+
+  def assert_links_displayed(*urls)
+    urls.each do |url|
+      assert_displayed %{#{url}}, :message => %{The url (#{url}) was not found in the response body.}
+    end
+  end
+  alias_method :assert_link_displayed, :assert_links_displayed
+
+  def assert_links_not_displayed(*urls)
+    urls.each do |url|
+      assert_not_displayed %{#{url}}, :message => %{The url (#{url}) should not be in the response body, but it is.}
+    end
+  end
+  alias_method :assert_link_not_displayed, :assert_links_not_displayed
+
+  def assert_displayed(text, options={})
+    if text.blank?
+      fail %{The text given was blank, and it should not be.}
+    end
+    message = options.delete :message
+    message ||= %{The text "#{text}" was not found in the response body, but it should have been.}
+    html = options.delete :html
+    html ||= @response.body
+    if options[:rjs]
+      html = unescape_rjs html 
+      html.gsub! '&amp;', '&'
+    end
+    assert html =~ /#{Regexp.escape(text.to_s)}/i, message
+  end
+  
+  def assert_not_displayed(text, options={})
+    if text.blank?
+      fail %{The text given was blank, and it should not be.}
+    end
+    message = options.delete :message
+    message ||= %{The text "#{text}" was found in the response body, but it should not have been.}
+    html = options.delete :html
+    html ||= @response.body
+    if options[:rjs]
+      html = unescape_rjs html 
+      html.gsub! '&amp;', '&'
+    end
+    assert_nil html =~ /#{Regexp.escape(text)}/i, message
+  end
+
+end

data/lib/shway.rb

@@ -0,0 +1,129 @@
+#loading order matters...  so don't alphabetize these. (trust me, I tried)
+require 'shway/helpers/shway_helper'
+
+require 'shway/css/css_styles'
+require 'shway/css/css_parser'
+require 'shway/css/css_helper'
+require 'shway/helpers/shway_controller_helper'
+
+require 'shway/extensions/routing_extensions'
+
+require 'shway/controllers/shway_controller'
+
+require 'shway/presenters/shway_presenter'
+require 'shway/presenters/shway_model_presenter'
+
+included_shway_helpers = [
+  Shway::Helpers::ShwayHelper,
+  Shway::Css::CssHelper,
+  Shway::Helpers::ShwayControllerHelper,
+  Shway::Helpers::HtmlHelper,
+]
+required_rails_helpers = [
+  ActionView::Helpers::TagHelper
+]
+
+#auto-include the shway helpers in the views, controllers and form builders
+required_rails_helpers.each do |rails_helper|
+  ActionView::Helpers::FormBuilder.send :include, rails_helper
+  ActionController::Base.send :include, rails_helper
+end
+included_shway_helpers.each do |shway_helper|
+  ActionController::Base.send :include, shway_helper
+  ActionView::Base.send :include, shway_helper
+  ActionView::Helpers::FormBuilder.send :include, shway_helper
+end
+ActionController::Routing::RouteSet::Mapper.send :include, Shway::Extensions::Routing::MapperExtensions
+
+module Shway
+  
+  class << self 
+
+    def load_styles
+      Shway::Css::CssStyles.load_styles
+    end
+
+    def reload_styles
+      Shway::Css::CssStyles.reload_styles
+    end
+    
+  end
+
+end
+
+#load the app's presenters and create accessors for them on ApplicationHelper
+#TRICK: we can't just use the after_initialize trick below for this since, in development, the helpers get reloaded every request and this gets lost.
+#TODO: make SURE this is the right way to do this. It does work though.
+#NOTE: I've tested this, and to_prepare is called on each request in development, but only once in production. So this looks like the right way to go.
+
+#this one adds the presenter helpers. I don't think I actually need this any more. 
+Rails.configuration.to_prepare do
+  presenters_path = File.join(RAILS_ROOT, 'app', 'presenters')
+  if File.exist?(presenters_path)
+    Dir.glob(File.join(presenters_path, '*_presenter.rb')).sort.each do |presenter_path|
+      #do NOT require the presenter. If you do, Rails class reloading won't work for the presenters.
+      # require presenter_path
+      presenter_name       = File.split(presenter_path).last.chomp('.rb')
+      presenter_class_name = presenter_name.camelize
+      define_string = %{
+        def #{presenter_name}(options={})
+          #{presenter_class_name}.new(self, options)
+        end
+      }
+      ApplicationHelper.class_eval define_string
+    end
+  end
+end
+
+#this will reload the styles once per request so you don't have to use css_reload anymore.
+Rails.configuration.to_prepare do
+  Shway.reload_styles
+end
+
+#this one adds the presenters to the load path
+Rails.configuration.after_initialize do
+  presenters_paths = [File.join(RAILS_ROOT, 'app', 'presenters'), File.join(RAILS_ROOT, 'app', 'presenters')]
+  presenters_paths.each do |presenters_path|
+    if File.exist?(presenters_path)
+      Dir.glob(File.join(presenters_path, '*_presenter.rb')).sort.each do |presenter_path|
+        presenter_dir   = File.dirname presenter_path
+        presenter_name  = File.split(presenter_path).last.chomp('.rb')
+        presenter_class_name = presenter_name.camelize
+        ActiveSupport::Dependencies.load_paths += %W( #{presenter_dir} )
+        ActiveSupport::Dependencies.explicitly_unloadable_constants << presenter_class_name
+      end
+    end
+  end
+end
+
+#MASSIVE HACK MODIFIED FROM fckeditor plugin init.
+
+# add the shway css routes
+class ActionController::Routing::RouteSet
+  unless (instance_methods.include?('draw_with_shway'))
+    class_eval %{
+      def draw_with_shway
+        draw_without_shway do |map|
+          map.shway_css
+          yield map
+        end
+      end
+      alias_method_chain :draw, :shway
+    }
+  end
+end
+
+# add the presenter helper and set it up in a before_filter a before
+
+class ActionController::Base
+
+  before_filter :setup_shway_presenter unless filter_chain.include? :setup_shway_presenter
+
+  #this is being done here now so that local stylesheets can reference skin styles and values.
+  # Shway.reload_styles
+
+  def setup_shway_presenter
+    @current_shway_presenter = ApplicationPresenter.new(self)
+  end
+
+end

data/shway.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shway}
+  s.version = "3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Owens"]
+  s.date = %q{2009-07-28}
+  s.description = %q{Provides powerful UI programming with dynamic css and presenters..}
+  s.email = %q{ryan@infoether.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/rubygems/commands/shway_init_command.rb", "lib/rubygems_plugin.rb", "lib/shway/controllers/shway_controller.rb", "lib/shway/css/css_helper.rb", "lib/shway/css/css_parser.rb", "lib/shway/css/css_styles.rb", "lib/shway/extensions/routing_extensions.rb", "lib/shway/helpers/html_helper.rb", "lib/shway/helpers/shway_controller_helper.rb", "lib/shway/helpers/shway_helper.rb", "lib/shway/presenters/shway_model_presenter.rb", "lib/shway/presenters/shway_presenter.rb", "lib/shway/test/shway_test_helper.rb", "lib/shway.rb", "README"]
+  s.files = ["CHANGELOG", "init.rb", "install.rb", "install_files/javascripts/iepngfix.htc", "install_files/javascripts/iepngfix_tilebg.js", "install_files/stylesheets/reset.css", "install_files/templates/example_presenter.rb", "install_files/templates/example_stylesheet.css.rb", "lib/rubygems/commands/shway_init_command.rb", "lib/rubygems_plugin.rb", "lib/shway/controllers/shway_controller.rb", "lib/shway/css/css_helper.rb", "lib/shway/css/css_parser.rb", "lib/shway/css/css_styles.rb", "lib/shway/extensions/routing_extensions.rb", "lib/shway/helpers/html_helper.rb", "lib/shway/helpers/shway_controller_helper.rb", "lib/shway/helpers/shway_helper.rb", "lib/shway/presenters/shway_model_presenter.rb", "lib/shway/presenters/shway_presenter.rb", "lib/shway/test/shway_test_helper.rb", "lib/shway.rb", "Manifest", "Rakefile", "README", "templates/css.html.erb", "templates/css.rhtml", "test/shway_core/css_config_test.rb", "test/shway_core/css_helper_test.rb", "test/shway_core/css_parser_test.rb", "test/shway_core/html_helper_test.rb", "test/shway_core/shway_controller_test.rb", "test/shway_core/shway_core_test_helper.rb", "test/shway_core/shway_helper_test.rb", "test/shway_core/shway_presenter_test.rb", "test/shway_core/shway_routes_test.rb", "test/shway_core/views/mock_foos/_list_header.html.erb", "test/shway_core/views/mock_foos/_list_item.html.erb", "test/shway_core/views/model_list/list_for_action.html.erb", "test/shway_core/views/model_list/list_item_for_action.html.erb", "test/shway_core/views/shway_helper_test.html.erb", "shway.gemspec"]
+  s.homepage = %q{http://rubyforge.org/projects/shway}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Shway", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{shway}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Provides powerful UI programming with dynamic css and presenters..}
+  s.test_files = ["test/shway_core/css_config_test.rb", "test/shway_core/css_helper_test.rb", "test/shway_core/css_parser_test.rb", "test/shway_core/html_helper_test.rb", "test/shway_core/shway_controller_test.rb", "test/shway_core/shway_helper_test.rb", "test/shway_core/shway_presenter_test.rb", "test/shway_core/shway_routes_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/templates/css.html.erb

@@ -0,0 +1,3 @@
+<%# I can't get render template to work, so we'll use file for now %>
+<%= render :file =>     "#{RAILS_ROOT}/public/stylesheets/#{@css_template}.css.erb", :use_full_path => true -%>
+<%#= render :template => "#{RAILS_ROOT}/public/stylesheets/#{@css_template}" -%>

data/templates/css.rhtml

@@ -0,0 +1,3 @@
+<%# This file is copied from css.html.erb and is necessary for older rails installs that don't support the new extentions %>
+<%# The filepaths are changed to *.rhtml from *.css.erb %>
+<%= render :file =>     "#{RAILS_ROOT}/public/stylesheets/#{@css_template}.rhtml", :use_full_path => true -%>

data/test/shway_core/css_config_test.rb

@@ -0,0 +1,186 @@
+require File.join(File.dirname(__FILE__), 'shway_test_helper')
+
+class CssConfigTest < Test::Unit::TestCase
+
+  include Shway::Css::CssHelper
+  include Shway::Helpers::ShwayHelper
+
+  def test_can_set_and_get_css_config_with_a_symbol_as_one_of_its_values_without_altering_it
+    set_valid_simple_css_config
+    retreived_config = get_css_config valid_simple_css_config_name
+    expected_valid_simple_css_config = valid_simple_css_config_values
+    assert_hashes_equal expected_valid_simple_css_config, retreived_config
+  end
+
+  def test_can_set_and_get_css_config_with_css_value_substitution
+    set_simple_css_value
+    set_valid_complex_css_config
+    retreived_config = get_css_config valid_complex_css_config_name
+    assert_hashes_equal expected_valid_complex_css_config, retreived_config
+  end
+  
+  def test_getting_nonexistent_css_config_raises
+    assert_raises RuntimeError do
+      get_css_config :nonexistent_css_config_name
+    end
+  end
+
+  def test_can_get_css_hash
+    set_valid_simple_css_style
+    retreived_hash = get_css_hash valid_simple_css_config_name
+    expected_css_hash = valid_simple_css_config_values
+    assert_hashes_equal expected_css_hash, retreived_hash
+  end
+
+  private
+  
+    #TODO figure out how to test a custom assertion like this
+    #TODO this is really an assert_hashes_equal with nice messages.
+    def assert_hashes_equal(hash_one, hash_two)
+      hash_one = hash_one.clone
+      hash_two = hash_two.clone
+      messages = []
+      hash_one.each do |key,value|
+        value_two = hash_two.delete key
+        unless value_two
+          messages << ":#{key} was only set in the first hash."
+        else
+          messages << ":#{key} has different values [#{value} (#{value.class}) | #{value_two} (#{value_two.class})] " unless value == value_two
+        end
+      end
+      hash_two.each do |key,value|
+        messages << ":#{key} was only set in the second hash."
+      end
+      fail messages.join unless messages.empty?
+    end
+  
+    #TODO it is unclear what the difference between these is. Clarify and improve tests.
+    def set_valid_simple_css_config
+      CssStyles.css_config valid_simple_css_config_name, valid_simple_css_config_values
+    end
+
+    def set_valid_simple_css_style
+      CssStyles.css_style valid_simple_css_config_name, valid_simple_css_config_values
+    end
+
+    def valid_simple_css_config_name
+      :valid_simple_config
+    end
+    
+    def valid_simple_css_config_values
+      {
+        :integer_value  => integer_value,
+        :string_value   => string_value,
+        :symbol_value   => symbol_value,
+        :class_value    => class_value,
+        :hash_value     => hash_value,
+      }
+    end
+
+    def set_valid_complex_css_config
+      CssStyles.css_config valid_complex_css_config_name, valid_complex_css_config_values
+    end
+
+    def valid_complex_css_config_name
+      :valid_complex_config
+    end
+    
+    def valid_complex_css_config_values
+      {
+        :integer_value  => integer_value,
+        :string_value   => string_value,
+        :css_value      => simple_css_value_name, ### name!
+        :class_value    => class_value,
+        :hash_value     => hash_value,
+      }
+    end
+
+    def expected_valid_complex_css_config
+      {
+        :integer_value  => integer_value,
+        :string_value   => string_value,
+        :css_value      => simple_css_value_value, ### value!
+        :class_value    => class_value,
+        :hash_value     => hash_value,
+      }
+    end
+    
+    def integer_value
+      1
+    end
+    
+    def string_value
+      'string'
+    end
+    
+    def symbol_value
+      :symbol
+    end
+    
+    def class_value
+      CssStyles
+    end
+
+    def hash_value
+      { :test => 'test'}
+    end
+
+    def set_simple_css_value
+      CssStyles.value simple_css_value_name => simple_css_value_value
+    end
+
+    def simple_css_value_name
+      :css_value_name
+    end
+
+    def simple_css_value_value
+      "Test Simple CSS Value"
+    end
+
+    def shway_config_names
+      [
+        :shway_edit_button,
+        :shway_done_button,
+        :shway_save_button,
+        :shway_change_button,
+        :shway_cancel_button,
+        :shway_delete_button,
+        :shway_child_image,
+        :shway_spacer_image,
+        :link_spacer
+      ]
+    end
+    
+    def shway_config_value_test_name
+      :shway_edit_button
+    end
+
+    def shway_config_value_test_expected_values
+      {
+        :image  => 'shway/rest/edit_button.gif', 
+        :width  => 45, 
+        :height => 19,
+        :style  => 'vertical-align: text-top',
+      }
+    end
+
+end
+
+
+
+
+# these were removed from shway core. they should be added to shway_browser
+
+# def test_shway_configs_get_loaded
+#   assert_nothing_raised do
+#     shway_config_names.each do |shway_config_name|
+#       get_css_config shway_config_name
+#     end
+#   end
+# end
+
+#this one is brittle, which is why we're only testing one
+# def test_the_values_of_one_shway_config_were_loaded_correctly
+#   actual_config_values = get_css_config shway_config_value_test_name
+#   assert_equal shway_config_value_test_expected_values, actual_config_values
+# end