link2 0.1.0

data/rails/init.rb

@@ -0,0 +1 @@
+require 'link2'

data/test/brain_test.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+require 'test_helper'
+
+class BrainTest < ActionView::TestCase
+
+  include ::Link2::Brain
+
+  def setup
+    ::I18n.locale = :en
+
+    @mookey = ::Fraggle.create(:name => 'Mookey')
+  end
+
+  test "#resource_identifier_class?: should only be true for valid classes" do
+    assert resource_identifier_class?(nil)
+    assert resource_identifier_class?(:hello)
+    assert resource_identifier_class?(::Fraggle)
+
+    assert_not resource_identifier_class?(::Unicorn)
+  end
+
+  test "#record_class?: should only be true for record classes" do
+    assert record_class?(::Fraggle)
+
+    assert_not record_class?(::Unicorn)
+  end
+
+  test "#controller_name_for_resource: should return controller name based on resource" do
+    assert_equal 'fraggles', controller_name_for_resource(::Fraggle)
+    assert_equal 'fraggles', controller_name_for_resource(::Fraggle.new)
+    assert_equal 'fraggles', controller_name_for_resource(:fraggle)
+  end
+
+  test "#controller_name_for_resource: should return current controller if no resource is specified or is nil" do
+    # Current: TestController
+    assert_equal 'test', controller_name_for_resource(nil)
+  end
+
+  test "#localized_label: should pass current controller to I18n options" do
+    swap ::Link2, :i18n_scopes => ['{{controller}}.links.{{action}}'] do
+      store_translations :en, {:fraggles => {:links => {:hello => "Wassup?!"}}} do
+        assert_equal "Wassup?!", localized_label(:hello, ::Fraggle)
+      end
+    end
+  end
+
+  test "#label_and_url_for_resource: should parse a label and url from a object (e.g. @post)" do
+    store_translations :en, {:links => {:show => "Show {{resource}}"}} do
+      assert_equal ["Show fraggle", fraggle_path(@mookey)], label_and_url_for_resource(@mookey)
+    end
+  end
+
+  test "#label_and_url_for_resource: should parse a label and url from a object (e.g. @post) with respect to to_s-value" do
+    store_translations :en, {:links => {:show => "Show {{name}}"}} do
+      @mookey.class_eval do
+        def to_s
+          ""
+        end
+      end
+      assert_equal ["Show fraggle", fraggle_path(@mookey)], label_and_url_for_resource(@mookey)
+
+      @mookey.class_eval do
+        def to_s
+          self.name
+        end
+      end
+      assert_equal ["Show Mookey", fraggle_path(@mookey)], label_and_url_for_resource(@mookey)
+    end
+  end
+
+  test "#label_and_url_for_resource: should parse correct label and url from a polymorphic args (e.g. [@user, :blog, @post])" do
+    @mookeys_cool_aid = ::CoolAid.create(:name => 'Super-tasty')
+
+    store_translations :en, {:links => {:show => "Show {{name}}"}} do
+      @mookeys_cool_aid.class_eval do
+        def to_s
+          self.name
+        end
+      end
+
+      assert_equal ["Show Super-tasty", fraggle_cool_aid_path(@mookey, @mookeys_cool_aid)], label_and_url_for_resource([@mookey, @mookeys_cool_aid])
+    end
+  end
+
+  test "#url_for_args: should use explicitly passed url if any" do
+    assert_equal '/posts', url_for_args(:new, '/posts')
+    assert_equal '/', url_for_args(:back, '/')
+  end
+
+  test "#url_for_args: should generate a url based on action only if mapping for this action exists" do
+    assert_equal '/', url_for_args(:home)
+    assert_equal :back, url_for_args(:back) # fix this to handle session[:return_to] in proc.
+  end
+
+  test "#url_for_args: should generate a url based on action and resource" do
+    # FIXME: stub(:session).returns({:return_to => '/'})
+
+    self.expects(:controller_name_for_resource).with(@mookey).returns('fraggles').twice
+    self.expects(:controller_name_for_resource).with(::Fraggle).returns('fraggles')
+    self.expects(:controller_name_for_resource).with(:fraggle).returns('fraggles')
+
+    assert_equal "/fraggles/new?id=#{@mookey.id}", url_for_args(:new, @mookey)
+    assert_equal '/fraggles/new', url_for_args(:new, ::Fraggle)
+    assert_equal '/fraggles/new', url_for_args(:new, :fraggle)
+
+    assert_equal "/fraggles/#{@mookey.id}/edit", url_for_args(:edit, @mookey)
+  end
+
+  # NOTICE: #link_to_args tested fully in HelpersTest as helpers are sort of identical.
+
+end

data/test/helpers_test.rb

@@ -0,0 +1,125 @@
+# encoding: utf-8
+require 'test_helper'
+
+class HelpersTest < ActionView::TestCase
+
+  include Link2::Helpers
+
+  def setup
+    ::I18n.locale = :en
+
+     @mookey = ::Fraggle.create(:name => 'Mookey')
+     @mookeys_cool_aid = ::CoolAid.create(:name => 'Super-tasty')
+  end
+
+  # link({}, {})
+
+  test "link() should raise error" do
+    assert_raise(::ArgumentError) { link }
+  end
+
+  # link(x, {}, {})
+
+  test "link(url) should render link_to(url, url)" do
+    assert_equal link_to('http://example.com', 'http://example.com'), link('http://example.com')
+    assert_equal link_to('/posts?by=date', '/posts?by=date'), link('/posts?by=date')
+  end
+
+  test "link(label) should render link_to(str_label, '#')" do
+    assert_equal link_to('Hello', '#'), link('Hello')
+  end
+
+  test "link(:action) should render link_to(t(:action, ...), url_for(:action => :action, ...)), auto-detecting resource" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      # assert_equal link_to("New Fraggle"), link(:new)
+      assert_raise(::Link2::NotImplementedYetError) { link(:new) }
+    end
+  end
+
+  test "link(:mapping) should render link_to(t(:mapping, ...), url_for_mapping(:mapping, ...)), auto-detecting resource" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      assert_equal link_to("Home", '/'), link(:home)
+
+      swap ::Link2, :action_mappings => {:secret => '/secret'} do
+        assert_equal link_to("Secret", '/secret'), link(:secret)
+      end
+    end
+  end
+
+  test "link(@resource) should render link_to(t(:show, ...), @object)" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      assert_equal link_to("Show", "/fraggles/#{@mookey.id}"), link(@mookey)
+      # assert_equal link_to("Show", "?"), link(::Fraggle) # test this stupid case?
+    end
+  end
+
+  test "link([@parent, @resource]) should render link_to(t(:show, ...), polymorphic_path([@parent, @resource]))" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      assert_equal link_to("Show", "/fraggles/#{@mookey.id}/cool_aids/#{@mookeys_cool_aid.id}"), link([@mookey, @mookeys_cool_aid])
+    end
+  end
+
+  # FINALIZE: link(x, y, {}, {})
+
+  test "link(label, url) should render link_to(label, url)" do
+    assert_equal link_to('http://example.com', 'http://example.com'), link('http://example.com', 'http://example.com')
+    assert_equal link_to('New', '/posts/new'), link('New', '/posts/new')
+  end
+
+  test "link(:action) should render link_to(label, url_for(:action => :action, ...)), auto-detecting resource" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      # assert_equal link_to("New Fraggle!!"), link("New Fraggle!!", :new)
+      assert_raise(::Link2::NotImplementedYetError) { link("New Fraggle!!", :new) }
+    end
+  end
+
+  test "link(label, action) should render link_to(label, url_for_mapping(:mapping, ...)), auto-detecting resource" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      assert_equal link_to("Home!!", '/'), link("Home!!", :home)
+
+      swap ::Link2, :action_mappings => {:secret => '/secret'} do
+        assert_equal link_to("Damn you!!", '/secret'), link("Damn you!!", :secret)
+      end
+    end
+  end
+
+  test "link(:action, Resource) should render link_to(t(:action, ...), url_for(:action => :action, ...))" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      assert_equal link_to("New", "/fraggles/new"), link(:new, ::Fraggle)
+    end
+  end
+
+  test "link(:action, @resource) should render link_to(t(:action, ...), url_for(:action => :action, ...))" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      # Non-RESTful-route, basic case.
+      assert_equal link_to("New", "/fraggles/new?id=#{@mookey.id}"), link(:new, @mookey)
+      # REST-case.
+      assert_equal link_to("Edit", "/fraggles/#{@mookey.id}/edit"), link(:edit, @mookey)
+    end
+  end
+
+  test "link(:action, [@parent, @resource]) should render link_to(t(:action, ...), polymorphic_path([@parent, @resource]), :action => :action)" do
+    swap ::Link2, :i18n_scopes => ['link.{{action}}'] do
+      # assert_equal link_to("Edit", "/fraggles/#{@mookey.id}/cool_aids/#{@mookeys_cool_aid.id}/edit"), link(:edit, [@mookey, @mookeys_cool_aid])
+      assert_raise(::Link2::NotImplementedYetError) {  link(:edit, [@mookey, @mookeys_cool_aid]) }
+    end
+  end
+
+  # link(x, y,  z, {}, {})
+
+  test "link(label, action, resource)" do
+    assert_equal link_to("Newish", "/fraggles/new"), link("Newish", :new, ::Fraggle)
+    assert_equal link_to("Editish", "/fraggles/#{@mookey.id}/edit"), link("Editish", :edit, @mookey)
+  end
+
+  test "js_link should not be implemented (yet)" do
+    assert_raise(::Link2::NotImplementedYetError) { js_link(:alert, 'alert("New");', {}, {}) }
+    assert_raise(::Link2::NotImplementedYetError) { js_button(:alert, 'alert("New");', {}, {}) }
+  end
+
+  test "ajax_link should not be implemented (yet)" do
+    assert_raise(::Link2::NotImplementedYetError) { ajax_link(:home, {}, {}) }
+    assert_raise(::Link2::NotImplementedYetError) { ajax_button(:home, {}, {}) }
+  end
+
+end

data/test/i18n_test.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+require 'test_helper'
+
+class I18nTest < ActiveSupport::TestCase
+
+  def setup
+    ::I18n.locale = :en
+  end
+
+  test "i18n: should load default translations automatically" do
+    options = {:scope => 'links', :resource => 'post', :resources => 'posts'}
+
+    ::I18n.backend.reload!
+
+    assert_equal "Home", ::I18n.t(:home, options)
+    assert_equal "Back", ::I18n.t(:back, options)
+
+    assert_equal "New post", ::I18n.t(:new, options)
+    assert_equal "Edit post", ::I18n.t(:edit, options)
+    assert_equal "Delete post", ::I18n.t(:delete, options)
+    assert_equal "Show post", ::I18n.t(:show, options)
+    assert_equal "Index of posts", ::I18n.t(:index, options)
+  end
+
+  test "i18n: should substitute scopes with parsed values for: controller, action, resource, resources" do
+    dummie_scopes = ['{{controller}}.{{resources}}.{{resource}}.{{action}}.label', 'links.{{action}}']
+    expected_substitution = [:'fraggles.fraggles.fraggle.new.label', :'links.new']
+
+    swap ::Link2, :i18n_scopes => dummie_scopes do
+      assert_raise(::Link2::I18n::ScopeInterpolationError) { ::Link2::I18n.send(:substituted_scopes_for, :new, ::Fraggle) }
+
+      assert_nothing_raised(::KeyError) { ::Link2::I18n.send(:substituted_scopes_for, :new, ::Fraggle, :controller => 'fraggles') }
+      assert_equal expected_substitution, ::Link2::I18n.send(:substituted_scopes_for, :new, ::Fraggle, :controller => 'fraggles')
+    end
+  end
+
+  test "i18n: should be able to translate action without any options" do
+    i18n_options = {:scope => 'links', :resource => 'fraggle', :resources => 'fraggles'}
+
+    assert_equal ::I18n.t(:new, i18n_options), ::Link2::I18n.t(:new, ::Fraggle)
+    assert_equal ::I18n.t(:new, i18n_options), ::Link2::I18n.t(:new, ::Fraggle.new)
+    assert_equal ::I18n.t(:new, i18n_options), ::Link2::I18n.t(:new, :fraggle)
+  end
+
+  test "i18n: should be able to translate action with respect to any valid extra interpolation arguments" do
+    swap ::Link2, :i18n_scopes => ['links.{{action}}'] do
+      store_translations :en, {:links => {:shout => 'Hello {{nick}}!'}} do
+        i18n_options = {:scope => 'links', :nick => 'Mokey'}
+
+        assert_equal ::I18n.t(:shout, i18n_options), ::Link2::I18n.t(:shout, ::Fraggle.new, :nick => 'Mokey')
+      end
+    end
+  end
+
+  test "i18n: should not interpolate values for any reserved interpolation keys" do
+    swap ::Link2, :i18n_scopes => ['links.{{action}}'] do
+      store_translations :en, {:links => {:shout => 'Hello {{scope}}!'}} do
+        i18n_options = {:scope => 'links', :name => 'Mokey'}
+
+        assert_raise(I18n::ReservedInterpolationKey) { ::Link2::I18n.t(:shout, ::Fraggle.new, :scope => 'Mokey') }
+      end
+    end
+  end
+
+end

data/test/link2_test.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+class Link2Test < ActiveSupport::TestCase
+
+  test "#setup: setup block yields self" do
+    Link2.setup do |config|
+      assert_equal Link2, config
+    end
+  end
+
+  test "#setup: should be configurable using setup helper" do
+    swap Link2, :i18n_scopes => ['links.{{action}}'] do
+      assert_equal ['links.{{action}}'], Link2.i18n_scopes
+    end
+
+    swap Link2, :action_mappings => {:home => '/'} do
+      assert_equal ({:home => '/'}), Link2.action_mappings
+    end
+  end
+
+  test "#url_for_mapping: should only map mapped action keys" do
+    swap Link2, :action_mappings => {:home_sweet_home => '/welcome'} do
+      assert_equal '/welcome', Link2.url_for_mapping(:home_sweet_home)
+      assert_nil Link2.url_for_mapping(:unicorns_and_rainbows)
+    end
+  end
+
+  test "#url_for_mapping: should be able to map procs" do
+    swap Link2, :action_mappings => {:home_sweet_home => lambda { '/welcome' }} do
+      assert_equal '/welcome', Link2.url_for_mapping(:home_sweet_home)
+    end
+  end
+
+  test "#url_for_mapping: should be able to map procs with custom url" do
+    swap Link2, :action_mappings => {:home_sweet_home => lambda { |url| url || '/welcome' }} do
+      #assert_equal '/get_lost', Link2.url_for_mapping(:home_sweet_home, '/get_lost')
+    end
+  end
+
+  # FAILS - see TODO:
+  # test "#url_for_mapping: should be able to map procs containing named route (or helper method)" do
+  #   swap Link2, :action_mappings => {:root => lambda { root_path }} do
+  #     assert_equal root_path, Link2.url_for_mapping(:root)
+  #   end
+  # end
+
+end

data/test/support/assertions_helper.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Link2
+  module AssertionsHelper
+    def assert_not(assertion)
+      assert !assertion
+    end
+
+    def assert_blank(assertion)
+      assert assertion.blank?
+    end
+
+    def assert_not_blank(assertion)
+      assert !assertion.blank?
+    end
+    alias :assert_present :assert_not_blank
+
+    def assert_no_select(*args)
+      assert_raise Test::Unit::AssertionFailedError do
+        assert_select(*args)
+      end
+    end
+  end
+end
+
+ActiveSupport::TestCase.class_eval do
+  include Link2::AssertionsHelper
+end

data/test/support/db_setup.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+ActiveSupport::TestCase.class_eval do
+  # self.use_transactional_fixtures = true
+  # self.use_instantiated_fixtures  = false
+end

data/test/support/debug_helper.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'i18n'
+
+module Link2
+  module DebugHelper
+
+    def debug_routes
+      ::ActionController::Routing::Routes.named_routes.each do |name, route|
+        puts "%20s: %s" % [name, route]
+      end
+    end
+
+  end
+end
+
+ActiveSupport::TestCase.class_eval do
+  include Link2::DebugHelper
+end

data/test/support/substitutions_helper.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'i18n'
+
+module Link2
+  module SubstitutionsHelper
+
+    # Execute the block setting the given values and restoring old values after
+    # the block is executed.
+    def swap(object, new_values)
+      old_values = {}
+      new_values.each do |key, value|
+        old_values[key] = object.send key
+        object.send :"#{key}=", value
+      end
+      yield
+    ensure
+      old_values.each do |key, value|
+        object.send :"#{key}=", value
+      end
+    end
+
+    def store_translations(locale, translations, &block)
+      current_translations = ::I18n.backend.send(:translations).send(:[], locale.to_sym)
+
+      begin
+        ::I18n.backend.store_translations locale, translations
+        yield
+      ensure
+        # ::I18n.reload!
+      end
+    end
+
+  end
+end
+
+ActiveSupport::TestCase.class_eval do
+  include Link2::SubstitutionsHelper
+end