flowmor_router 0.1.1 → 0.2.1

data/test/dummy/test/integration/routable_records_test.rb

@@ -4,7 +4,7 @@ class RoutableRecordsTest < ActionDispatch::IntegrationTest
   test "/general/lets-test-this" do
     post = Post.create(title: "Let's Test This")
     assert_equal post.name, 'lets-test-this'
-    assert_equal "/general/lets-test-this", post.path
+    assert_equal "/by_category/posts/general/lets-test-this", post.path
     get post.path
     assert_response :success
     assert_select "h1", "Let's Test This"
@@ -13,6 +13,7 @@ class RoutableRecordsTest < ActionDispatch::IntegrationTest
   test "only routable routes built" do 
     a1 = Article.create(title: "Route This", published: true)
     a2 = Article.create(title: "Ignore This", published: false)
+    Rails.logger.info "\nROUTES: #{Rails.application.routes.routes.collect {|r| r.name }.inspect}"
     get a1.path
     assert_response :success
     assert_raise FlowmorRouter::UnroutedRecord do

data/test/dummy/test/models/article_test.rb

@@ -1,22 +1,26 @@
 require 'test_helper'
 
 class ArticleTest < ActiveSupport::TestCase
-  test "article#controller_action" do
-    assert Article.new.controller_action, "article#show"
+  setup do 
+    @article = Article.create(title: "Dummy Article", published: true)
   end
   
-  test "article#route_name" do 
-    assert Article.new(title: "Dummy Article").route_name, 'articles_dummy_article'
+  test "article#flowmor_article_articles_router_class is a RouterClasses class" do 
+    assert @article.flowmor_articles_router_class.is_a?(FlowmorRouter::RouterClasses)
   end
-  
-  test "article#route_name_prefix" do
-    assert Article.new(title: "Dummy Article").route_name_prefix, 'article'
+
+  test "RouterClasses has Article registered" do 
+    assert FlowmorRouter::RouterClasses.router_classes.map(&:model).include? Article
   end
   
-  test "article#derived_name_field_value" do 
-    assert Article.new(title: "Dummy Article").derived_name_field_value, 'dummy-article'
+  test "article#route_name" do 
+    assert_equal 'articles_dummy_article', @article.route_name
   end
 
+  test "article#controller_action" do
+    assert Article.new.flowmor_articles_router_class.controller_action, "article#show"
+  end
+  
   test "unpublished articles not routed" do 
     published = Article.create(title: "Published", published: true)
     unpublished = Article.create(title: "Unpublished", published: false)
@@ -32,11 +36,8 @@ class ArticleTest < ActiveSupport::TestCase
     assert_raise FlowmorRouter::UnroutableRecord do
       Article.new(title: nil).path
     end
-    assert_raise FlowmorRouter::UnroutableRecord do
-      Article.create(title: nil).path
-    end
-    assert_raise FlowmorRouter::UnroutedRecord do
-      assert Article.create(title: "Dummy Article").path, '/articles/dummy-article'
-    end
+    titleless_article = Article.create(title: nil, published: true)
+    assert_equal "/articles/#{titleless_article.id}", titleless_article.path
+    assert Article.create(title: "Another Article", published: true).path, '/articles/another-article'
   end
 end

data/test/dummy/test/models/news_article_test.rb

@@ -1,34 +1,14 @@
 require 'test_helper'
 
 class NewsArticleTest < ActiveSupport::TestCase
-  test "news_article#controller_action" do
-    assert_equal "news_article#show", NewsArticle.new.controller_action
-  end
-  
   test "news_article#route_name" do 
     assert_equal 'news_articles_dummy_news_article', NewsArticle.new(caption: "Dummy News Article").route_name
   end
   
-  test "news_article#route_name_prefix" do
-    assert_equal 'news_articles', NewsArticle.new(caption: "Dummy News Article").route_name_prefix
-  end
-  
-  test "news_article#derived_name_field_value" do 
-    assert_equal 'Dummy News Article', NewsArticle.new(caption: "Dummy News Article").derived_name_field_value
+  test "NewsArticle controller_action" do 
+    assert_equal 'news_article#show', NewsArticle.flowmor_news_articles_router_class.controller_action
   end
-  
-  test "news_article#new_name_value" do 
-    assert_equal 'dummy-news-article', NewsArticle.new(caption: "Dummy News Article").new_name_value
-  end
-  
-  test "news_article#slug" do 
-    assert_equal 'dummy-news-article', NewsArticle.create(caption: "Dummy News Article").slug
-  end
-  
-  test "NewsArticle#route_model" do 
-    assert_equal 'news_article', NewsArticle.route_model
-  end
-  
+
   test "news_article#path" do
     assert_raise FlowmorRouter::UnroutableRecord do
       NewsArticle.new(caption: nil).path
@@ -36,7 +16,9 @@ class NewsArticleTest < ActiveSupport::TestCase
     assert_raise FlowmorRouter::UnroutableRecord do
       NewsArticle.create(caption: nil).path
     end
-    assert_equal '/news-articles/dummy-news-article', NewsArticle.create(caption: "Dummy News Article").path
+    real_article = NewsArticle.create(caption: "Real News Article")
+    assert_equal '/news_articles/real-news-article', Rails.application.routes.url_helpers.news_articles_real_news_article_path
+    assert_equal '/news_articles/real-news-article', real_article.path
   end
   
   test "news_article#url" do 
@@ -46,5 +28,10 @@ class NewsArticleTest < ActiveSupport::TestCase
     assert_raise FlowmorRouter::UnroutableRecord do
       NewsArticle.create(caption: nil).url
     end
+
+    real_article = NewsArticle.create(caption: "Real News Article")
+    Thread.current[:host] = "localhost"
+    Thread.current[:port] = "3000"
+    assert_equal 'http://localhost:3000/news_articles/real-news-article', real_article.url
   end
 end

data/test/dummy/test/models/post_category_test.rb

@@ -1,30 +1,14 @@
 require 'test_helper'
 
 class PostCategoryCategoryTest < ActiveSupport::TestCase
-  test "post_category#controller_action" do
-    assert_equal "blog#category", PostCategory.new.controller_action
-  end
-  
   test "post_category#route_name" do 
-    assert_equal 'categories_general', PostCategory.new(title: "General").route_name
+    assert_equal 'category_general', PostCategory.new(name: "general").route_name
   end
   
-  test "post_category#route_name_prefix" do
-    assert_equal 'categories', PostCategory.new(title: "General").route_name_prefix
+  test "PostCategory controller_action" do 
+    assert_equal 'blog#category', PostCategory.flowmor_category_router_class.controller_action
   end
 
-  test "post_category#derived_name_field_value" do 
-    assert_equal 'General', PostCategory.new(title: "General").derived_name_field_value
-  end
-  
-  test "post_category#new_name_value" do 
-    assert_equal 'general', PostCategory.new(title: "General").new_name_value
-  end
-  
-  test "PostCategory#route_model" do 
-    assert_equal 'category', PostCategory.route_model
-  end
-  
   test "post_category#path" do
     assert_raise FlowmorRouter::UnroutableRecord do
       PostCategory.new(title: nil).path
@@ -32,15 +16,6 @@ class PostCategoryCategoryTest < ActiveSupport::TestCase
     assert_raise FlowmorRouter::UnroutableRecord do
       PostCategory.create(title: nil).path
     end
-    assert_equal '/categories/general', PostCategory.create(title: "General").path
-  end
-  
-  test "post_category#url" do 
-    assert_raise FlowmorRouter::UnroutableRecord do
-      PostCategory.new(title: nil).url
-    end
-    assert_raise FlowmorRouter::UnroutableRecord do
-      PostCategory.create(title: nil).url
-    end
+    assert_equal '/category/general', PostCategory.create(title: "General").path
   end
 end

data/test/dummy/test/models/post_test.rb

@@ -1,54 +1,24 @@
 require 'test_helper'
 
 class PostTest < ActiveSupport::TestCase
-  test "post#controller_action" do
-    assert_equal "blog#show", Post.new.controller_action
-  end
-  
-  test "default category is 'general'" do 
-    assert_equal 'general', Post.new.category_name
+  setup do
+    @category = PostCategory.create(name: "general")
+    @post = Post.create(title: "Once Upon a Time")
   end
   
   test "post#route_name" do 
-    assert_equal 'posts_general_dummy_post', Post.new(title: "Dummy Post").route_name
-  end
-  
-  test "post#route_name_prefix" do
-    assert_equal 'posts_general', Post.new(title: "Dummy Post").route_name_prefix
-  end
-
-  test "post#derived_name_field_value" do 
-    assert_equal 'Dummy Post', Post.new(title: "Dummy Post").derived_name_field_value
+    assert_equal 'by_category_posts_general_once_upon_a_time', @post.route_name
   end
   
-  test "post#new_name_value" do 
-    assert_equal 'dummy-post', Post.new(title: "Dummy Post").new_name_value
-  end
-  
-  test "Post#route_model" do 
-    assert_equal 'post', Post.route_model
-  end
-  
-  test "post#route" do
-    assert_equal Post.new(title: "Dummy Post", name: "dummy-post").route, '/general/dummy-post'
+  test "Post controller_action" do 
+    assert_equal 'blog#show', Post.flowmor_posts_router_class.controller_action
   end
 
   test "post#path" do
-    assert_raise FlowmorRouter::UnroutableRecord do
-      Post.new(title: nil).path
-    end
-    assert_raise FlowmorRouter::UnroutableRecord do
-      Post.create(title: nil).path
-    end
-    assert_equal '/general/dummy-post', Post.create(title: "Dummy Post").path
+    assert_equal '/by_category/posts/general/once-upon-a-time', @post.path
   end
-  
-  test "post#url" do 
-    assert_raise FlowmorRouter::UnroutableRecord do
-      Post.new(title: nil).url
-    end
-    assert_raise FlowmorRouter::UnroutableRecord do
-      Post.create(title: nil).url
-    end
+
+  test "post#archive_path" do
+    assert_equal '/archive/once-upon-a-time', @post.archive_path
   end
 end

data/test/router_classes_test.rb

@@ -0,0 +1,219 @@
+require 'test_helper'
+require 'flowmor_router'
+
+# require 'action_dispatch/routing/inspector'
+# Rails.application.routes_reloader.reload!
+# puts "ROUTES: #{Rails.application.routes.routes.collect {|r| r.name }.inspect}"
+
+module FlowmorRouter 
+  class RouterClassesTest < ActiveSupport::TestCase
+    
+    class Foo 
+      include ActiveModel::AttributeMethods
+      define_attribute_methods :title, :slug, :name, :alt_name, :caption, :id
+      attr_accessor :title, :slug, :name, :alt_name, :caption, :id
+      
+      @@routable = []
+
+      class << self
+        def after_save *args
+        end
+        alias :before_save :after_save
+        alias :scope :after_save
+      end
+
+      def self.routable
+        @@routable
+      end
+
+      def initialize(title, slug)
+        @id = 1
+        @title = title
+        @caption = "#{title} (captioned)"
+        @slug = slug
+        @name = slug
+        @alt_name = "alt-#{slug}"
+        self.class.routable << self
+      end
+      
+      include FlowmorRouter::ActsAsRoutable
+    end
+    
+    test "defined correctly" do
+      assert_kind_of Class, FlowmorRouter::RouterClasses
+    end
+  
+    test "can register a class" do
+      begin
+        RouterClasses.register :obj, Object, {}
+        assert RouterClasses.router_classes.map(&:model).include?(Object)
+        assert RouterClasses.router_classes.map(&:actor).include?("obj")
+      ensure
+        RouterClasses.unregister Object
+      end
+    end
+    
+    test "Bar becomes routable" do
+      begin
+        class Bar < Foo
+          acts_as_routable
+        end
+      
+        item = Bar.new("FooBar", "foo-bar")
+        rc = RouterClasses.router_classes.detect{|d| d.model == Bar}
+        
+        assert_equal Bar,                     rc.model
+        assert_equal "bars",                  rc.actor
+        assert_equal "bar#show",              rc.controller_action
+        assert_equal "bars",                  rc.route_base_name
+        assert_equal "/bars",                 rc.route_base_path
+        assert_equal "foo-bar",               rc.name(item)
+        assert_equal "flowmor_bars_routable", rc.scope_name
+        assert_equal "/bars/foo-bar",         rc.route_path(item)
+        assert_equal "path",                  rc.path_method_name
+        assert_equal "url",                   rc.url_method_name
+        assert_equal "bars_foo_bar",          rc.route_name(item)
+      ensure
+        RouterClasses.unregister Bar
+      end
+    end
+    
+    test "Baz becomes routable with named model" do
+      begin
+        class Baz < Foo
+          acts_as_routable :foobaz, 
+            prefix: [:foo, :bazs], 
+            name_field: :alt_name,
+            title_field: :caption
+        end
+
+        item = Baz.new("FooBaz", "foo-baz")
+        rc = RouterClasses.router_classes.detect{|d| d.model == Baz}
+        
+        assert_equal Baz,                                 rc.model
+        assert_equal "foobaz",                            rc.actor
+        assert_equal "foobaz#show",                       rc.controller_action
+        assert_equal [:foo, :bazs],                       rc.route_prefix(item)
+        assert_equal "foobaz",                            rc.route_base_name
+        assert_equal "/foobaz",                           rc.route_base_path
+        assert_equal "alt-foo-baz",                       rc.name(item)
+        assert_equal "flowmor_foobaz_routable",           rc.scope_name
+        assert_equal "/foo/bazs/foobaz/alt-foo-baz",      rc.route_path(item)
+        assert_equal "path",                              rc.path_method_name
+        assert_equal "url",                               rc.url_method_name
+        assert_equal "foo_bazs_foobaz_alt_foo_baz",       rc.route_name(item)
+      ensure
+        RouterClasses.unregister Baz
+      end
+    end
+    
+    test "Bat becomes routable with named model" do
+      begin
+        class Bat < Foo
+          def batty
+            "coo_coo-for-coco_puffs"
+          end
+          
+          def custom_route
+            "/foo/#{batty}"
+          end
+          
+          def category 
+            :crazy
+          end
+          
+          acts_as_routable route: :custom_route, prefix: -> { :category }
+        end
+       
+        item = Bat.new("FooBar", "foo-bar")
+        rc = RouterClasses.router_classes.detect{|d| d.model == Bat}
+
+        assert_equal Bat,                           rc.model
+        assert_equal "flowmor_bats_routable",       rc.scope_name
+        assert_equal "bats",                        rc.actor
+        assert_equal "bat#show",                    rc.controller_action
+        assert_equal "bats",                        rc.route_base_name
+        assert_equal "/bats",                       rc.route_base_path
+        assert_equal "foo-bar",                     rc.name(item)
+        assert_equal "/foo/coo_coo-for-coco_puffs", rc.route_path(item)
+        assert_equal "path",                        rc.path_method_name
+        assert_equal "url",                         rc.url_method_name
+        assert_equal "crazy_bats_foo_bar",          rc.route_name(item)
+        assert_equal [:crazy],                      rc.route_prefix(item)
+      ensure
+        RouterClasses.unregister Bat
+      end
+    end
+
+    test "Down becomes routable with named model" do
+      begin
+        class Down < Foo
+          
+          acts_as_routable delimiter: "_"
+        end
+       
+        item = Down.new("A Serious Downer", nil)
+        rc = RouterClasses.router_classes.detect{|d| d.model == Down}
+
+        assert_equal Down,                      rc.model
+        assert_equal "flowmor_downs_routable",  rc.scope_name
+        assert_equal "downs",                   rc.actor
+        assert_equal "down#show",               rc.controller_action
+        assert_equal "downs",                   rc.route_base_name
+        assert_equal "/downs",                  rc.route_base_path
+        assert_equal "a_serious_downer",        rc.name(item)
+        assert_equal "/downs/a_serious_downer", rc.route_path(item)
+        assert_equal "path",                    rc.path_method_name
+        assert_equal "url",                     rc.url_method_name
+        assert_equal "downs_a_serious_downer",  rc.route_name(item)
+        assert_equal nil,                       rc.route_prefix(item)
+      ensure
+        RouterClasses.unregister Down
+      end
+    end
+
+    test "Fib becomes routable with named model" do
+      begin
+        class Fib < Foo
+          
+          def custom_name
+            ["so_called", name.parameterize].join("-")
+          end
+          
+          acts_as_routable name: :custom_name
+          acts_as_routable :archive, controller_action: "fib#archive", name: :custom_name
+        end
+       
+        item = Fib.new("FooBar", "foo-bar")
+        rc = Fib.flowmor_fibs_router_class
+        rca = Fib.flowmor_fibs_archive_router_class
+        
+        assert_equal Fib,                       rc.model
+        assert_equal "fibs",                    rc.actor
+        assert_equal "fib#show",                rc.controller_action
+        assert_equal "fibs",                    rc.route_base_name
+        assert_equal "/fibs",                   rc.route_base_path
+        assert_equal "so_called-foo-bar",       rc.name(item)
+        assert_equal "flowmor_fibs_routable",   rc.scope_name
+        assert_equal "/fibs/so_called-foo-bar", rc.route_path(item)
+        assert_equal "path",                    rc.path_method_name
+        assert_equal "url",                     rc.url_method_name
+        assert_equal "fibs_so_called_foo_bar",  rc.route_name(item)
+
+        assert_equal Fib,                               rca.model
+        assert_equal "archive",                         rca.actor
+        assert_equal "fib#archive",                     rca.controller_action
+        assert_equal "fibs_archive",                    rca.route_base_name
+        assert_equal "/archive",                        rca.route_base_path
+        assert_equal "so_called-foo-bar",               rca.name(item)
+        assert_equal "flowmor_fibs_archive_routable",   rca.scope_name
+        assert_equal "/archive/so_called-foo-bar",      rca.route_path(item)
+        assert_equal "archive_path",                    rca.path_method_name
+        assert_equal "archive_url",                     rca.url_method_name
+        assert_equal "fibs_archive_so_called_foo_bar",  rca.route_name(item)
+      ensure
+        RouterClasses.unregister Fib
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flowmor_router
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Michael Lang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,9 +56,12 @@ files:
 - bin/rails
 - config/routes.rb
 - lib/flowmor_router.rb
-- lib/flowmor_router/acts_as_flowmor_routable.rb
+- lib/flowmor_router/acts_as_routable.rb
 - lib/flowmor_router/engine.rb
 - lib/flowmor_router/exceptions.rb
+- lib/flowmor_router/foo.rb
+- lib/flowmor_router/proxy_foo.rb
+- lib/flowmor_router/router_classes.rb
 - lib/flowmor_router/version.rb
 - lib/tasks/flowmor_router_tasks.rake
 - test/dummy/README.rdoc
@@ -149,6 +152,7 @@ files:
 - test/dummy/tmp/cache/assets/test/sprockets/f7cbd26ba1d28d48de824f0e94586655
 - test/flowmor_router_test.rb
 - test/integration/navigation_test.rb
+- test/router_classes_test.rb
 - test/test_helper.rb
 homepage: https://github.com/mwlang/flowmor_router
 licenses:
@@ -263,5 +267,6 @@ test_files:
 - test/dummy/tmp/cache/assets/test/sprockets/f7cbd26ba1d28d48de824f0e94586655
 - test/flowmor_router_test.rb
 - test/integration/navigation_test.rb
+- test/router_classes_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/flowmor_router/acts_as_flowmor_routable.rb

@@ -1,122 +0,0 @@
-module FlowmorRouter
-  module ActsAsFlowmorRoutable
-    extend ActiveSupport::Concern
-    
-    def controller_action
-      self.class.controller_action
-    end
-
-    included do
-      
-      after_save :reload_routes
-      before_save :populate_name
-
-      def derived_name_field_value
-        send(self.derived_name_field)
-      end
-
-      def reload_routes
-        Rails.application.routes_reloader.reload!
-      end
-
-      def populate_name
-        if attributes[name_field].blank? || name_field_changed?
-          send("#{name_field}=", new_name_value)
-        end
-      end
-
-      def route_prefix
-        "/#{self.route_model.pluralize.gsub('_', '-')}"
-      end
-
-      def route
-        "#{route_prefix}/#{new_name_value}"
-      end
-
-      def default_url_options
-        { :host => Thread.current[:host], :port => Thread.current[:port] }
-      end
-
-      def url
-        begin
-          FlowmorRouter::Engine.routes.url_helpers.send("#{route_name}_url", default_url_options)
-        rescue NoMethodError
-          raise FlowmorRouter::UnroutedRecord.new("#{self.inspect} was not routed.")
-        end
-      end
-      def name_field
-        self.class.name_field
-      end
-
-      def name_field_value
-        attributes[name_field]
-      end
-
-      def path
-        begin
-          Rails.application.routes.url_helpers.send("#{route_name}_path")
-        rescue NoMethodError
-          raise FlowmorRouter::UnroutedRecord.new("#{self.inspect} was not routed.")
-        end
-      end
-
-      def route_name
-        name_suffix = new_name_value
-        raise UnroutableRecord if name_suffix.blank?
-
-        "#{route_name_prefix}_#{name_suffix}".underscore
-      end
-
-      def route_name_prefix
-        "#{self.route_model.pluralize}"
-      end
-
-      def new_name_value
-        if value = derived_name_field_value and !value.blank?
-          value.downcase.gsub(/[^\w\s\d\_\-]/,'').gsub(/\s\s+/,' ').gsub(/[^\w\d]/, '-')
-        else
-          raise FlowmorRouter::UnroutableRecord if value.blank?
-        end
-      end
-
-      def name_field_changed?
-        new_name_value != attributes[name_field]
-      end
-
-    end
-
-    module LocalInstanceMethods
-    end
-    
-    module ClassMethods
-      def default_controller_action
-        "#{self.route_model.underscore}#show"
-      end
-
-      def controller_action
-        @controller_action || default_controller_action
-      end
-
-      def acts_as_routable(options = {})
-        ROUTABLE_MODEL_CLASSES << self
-        scope :routable, options[:scope] || lambda {}
-
-        class_attribute :route_model
-        self.route_model = options[:route_model] || name.underscore.downcase
-
-        class_attribute :name_field
-        self.name_field = (options[:name_field] || :name).to_s
-
-        class_attribute :derived_name_field
-        self.derived_name_field = (options[:derived_name_field] || :title).to_s
-
-        class_attribute :controller_action
-        self.controller_action = (options[:controller_action] || default_controller_action)
-        
-        include LocalInstanceMethods
-      end
-    end
-  end
-end
- 
-ActiveRecord::Base.send :include, FlowmorRouter::ActsAsFlowmorRoutable