push_type_core 0.3.3 → 0.4.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cadc2e0370adc5c49557963ec33d7dd1f8bc46de
-  data.tar.gz: 77f3676187d5d731f1c5ceea31cfd6229f612210
+  metadata.gz: 197268baf4847b3e83ceffd40d9f70878c081b43
+  data.tar.gz: c3390f38682d7cb78f24357532e2275ec15dd913
 SHA512:
-  metadata.gz: 017d0d10aec5e3a869b57f4bdcaccc88f6f9f4515498299ec3bf3e29611dfae9fd1144c935dd15a22bd3abccc9b5a814738461bdbc17f8eb35c27da6b6d32709
-  data.tar.gz: 3336662a36f969e8014287cf5c064463e7c6a7a0ee3daca79eaf6d632bd12198addf34163e8859e7bff362407bb04c090cbd3e44532c98b0f208315c67e4e68f
+  metadata.gz: 5eba96db43bd908242d406c54b485773fa8167f8c27b2c7dc931499dd0cb74a742e67fcb006472016c12217cd02c4219997e7c20cd898a0597a471fbb20785a4
+  data.tar.gz: 5b9e5da50f1e94d9fa4e252ee54d5cd10a619d0b3f678e5f46b7737fb0db4eae6fdf7c6e1124c848058551e97cc8f19c6dd721a2d11c7ca84a292703b0584de0

data/app/controllers/concerns/push_type/application_controller_methods.rb

@@ -2,8 +2,13 @@ module PushType
   module ApplicationControllerMethods
     extend ActiveSupport::Concern
 
+    FILTERS = [
+      :before_node_load_filters, :before_node_action_filters, :after_node_action_filters,
+      :before_taxonomy_load_filters, :before_taxonomy_action_filters, :after_taxonomy_action_filters
+    ]
+
     included do
-      class_attribute :before_load_filters, :before_node_filters, :after_node_filters
+      class_attribute *FILTERS
     end
 
     protected
@@ -14,59 +19,19 @@ module PushType
 
     private
 
-    def before_load_filters
-      self.class.before_load_filters
-    end
-
-    def before_node_filters
-      self.class.before_node_filters
-    end
-
-    def after_node_filters
-      self.class.after_node_filters
-    end
-
-    def run_node_hook(*args)
-      methods_or_proc, opts = case args.last
-        when Proc then args.first.is_a?(Hash) ? [ args.last, args.first ] : [ args.last, {} ]
-        when Hash then [ args[0..-2], args.last ]
-        else [ args, {} ]
-      end
-
-      unless node_type_not_in_option(opts[:only]) || node_type_in_option(opts[:except])
-        if methods_or_proc.respond_to?(:call)
-          instance_exec(&methods_or_proc)
-        else
-          Array(methods_or_proc).each { |m| send(m) }
-        end
-      end
-    end
-
-    def node_type_in_option(types)
-      types && @node && Array(types).include?(@node.type.underscore.to_sym)
-    end
-
-    def node_type_not_in_option(types)
-      types && @node && !Array(types).include?(@node.type.underscore.to_sym)
+    FILTERS.each do |filter|
+      define_method(filter) { self.class.send(filter) }
     end
 
     module ClassMethods
-      def before_node_load(*args, &block)
-        args.push block if block_given?
-        self.before_load_filters ||= []
-        self.before_load_filters.push << args
-      end
-
-      def before_node_action(*args, &block)
-        args.push block if block_given?
-        self.before_node_filters ||= []
-        self.before_node_filters << args
-      end
+      FILTERS.each do |filter|
+        method_name = filter.to_s.gsub(/_filters$/, '')
 
-      def after_node_action(*args, &block)
-        args.push block if block_given?
-        self.after_node_filters ||= []
-        self.after_node_filters << args
+        define_method method_name do |*args, &block|
+          args.push block if block
+          filters = ( self.send(filter) || [] ) << args
+          self.send "#{ filter }=", filters
+        end
       end
     end
 

data/app/controllers/concerns/push_type/filterable.rb

@@ -0,0 +1,69 @@
+module PushType
+  module Filterable
+    extend ActiveSupport::Concern
+
+    private
+
+    def filter_scope
+      self.class.filter_scope
+    end
+
+    def filter_obj
+      instance_variable_get "@#{ filter_scope }"
+    end
+
+    def filter_obj_type
+      filter_obj.type.underscore.to_sym
+    end
+
+    def before_load_filters
+      filters = self.send("before_#{ filter_scope }_load_filters")
+      filters.each { |f| run_node_hook(*f) } unless filters.blank?
+    end
+
+    def around_action_filters
+      before_filters = self.send("before_#{ filter_scope }_action_filters")
+      before_filters.each { |f| run_node_hook(*f) } unless before_filters.blank?
+      yield
+      after_filters = self.send("after_#{ filter_scope }_action_filters")
+      after_filters.each { |f| run_node_hook(*f) } unless after_filters.blank?
+    end
+
+    def run_node_hook(*args)
+      methods_or_proc, opts = case args.last
+        when Proc then args.first.is_a?(Hash) ? [ args.last, args.first ] : [ args.last, {} ]
+        when Hash then [ args[0..-2], args.last ]
+        else [ args, {} ]
+      end
+
+      unless filter_obj_not_in(opts[:only]) || filter_obj_in(opts[:except])
+        if methods_or_proc.respond_to?(:call)
+          instance_exec(&methods_or_proc)
+        else
+          Array(methods_or_proc).each { |m| send(m) }
+        end
+      end
+    end
+
+    def filter_obj_in(types)
+      types && filter_obj && Array(types).include?(filter_obj_type)
+    end
+
+    def filter_obj_not_in(types)
+      types && filter_obj && !Array(types).include?(filter_obj_type)
+    end
+
+    module ClassMethods
+
+      attr_reader :filter_scope
+
+      def hooks_for(sym, opts)
+        @filter_scope = sym
+        prepend_before_action :before_load_filters, opts
+        around_action :around_action_filters, opts
+      end
+
+    end
+
+  end
+end

data/app/controllers/front_end_controller.rb

@@ -1,23 +1,9 @@
 class FrontEndController < ApplicationController
 
-  before_action :before_load, :load_node, :before_node, only: :node
-  after_action :after_node, only: :node
-
-  def node
-    render *@node.template_args
-  end
+  include PushType::Filterable
 
   private
 
-  def load_node
-    @node = PushType::Node.published.find_by_path permalink_path
-    if @node
-      instance_variable_set "@#{ @node.type.underscore }", @node.present!(view_context)
-    else
-      raise_404
-    end
-  end
-
   def root_path?
     request.fullpath == '/'
   end
@@ -30,22 +16,4 @@ class FrontEndController < ApplicationController
     end
   end
 
-  def before_load
-    unless before_load_filters.blank?
-      before_load_filters.each { |f| run_node_hook(*f) }
-    end
-  end
-
-  def before_node
-    unless before_node_filters.blank?
-      before_node_filters.each { |f| run_node_hook(*f) }
-    end
-  end
-
-  def after_node
-    unless after_node_filters.blank?
-      after_node_filters.each { |f| run_node_hook(*f) }
-    end
-  end
-  
 end

data/app/controllers/nodes_front_end_controller.rb

@@ -0,0 +1,21 @@
+class NodesFrontEndController < FrontEndController
+
+  before_action :load_node, only: :show
+  hooks_for :node, only: :show
+
+  def show
+    render *@node.template_args
+  end
+
+  private
+
+  def load_node
+    @node = PushType::Node.exposed.published.find_by_path permalink_path
+    if @node
+      instance_variable_set "@#{ @node.type.underscore }", @node.present!(view_context)
+    else
+      raise_404
+    end
+  end
+
+end

data/app/controllers/taxonomies_front_end_controller.rb

@@ -0,0 +1,25 @@
+class TaxonomiesFrontEndController < FrontEndController
+
+  before_action :load_taxonomy, only: :show
+  hooks_for :taxonomy, only: :show
+
+  def show
+    render *@taxonomy.template_args
+  end
+
+  private
+
+  def load_taxonomy
+    @taxonomy = taxonomy_class.find_by_path(permalink_path)
+    if @taxonomy
+      instance_variable_set "@#{ @taxonomy.type.underscore }", @taxonomy
+    else
+      raise_404
+    end
+  end
+
+  def taxonomy_class
+    PushType::Taxonomy.descendants(exposed: true).find { |t| t.base_slug == params[:taxonomy] } or raise_404
+  end
+
+end

data/app/models/concerns/push_type/nestable.rb

@@ -29,7 +29,7 @@ module PushType
 
       def child_nodes
         types = @child_nodes || PushType.config.root_nodes
-        PushType.node_types_from_list(types)
+        PushType.subclasses_from_list(:node, types)
       end
 
       def has_child_nodes(*args)

data/app/models/concerns/push_type/publishable.rb

@@ -6,9 +6,9 @@ module PushType
       enum status: [ :draft, :published ]
 
       scope :published, -> {
-        not_trash.exposed.
-          where(['push_type_nodes.status = ? AND push_type_nodes.published_at <= ?', self.statuses[:published], Time.zone.now]).
-          where(['push_type_nodes.published_to IS NULL OR push_type_nodes.published_to > ?', Time.zone.now])
+        not_trash
+          .where(['push_type_nodes.status = ? AND push_type_nodes.published_at <= ?', self.statuses[:published], Time.zone.now])
+          .where(['push_type_nodes.published_to IS NULL OR push_type_nodes.published_to > ?', Time.zone.now])
       }
 
       after_initialize :set_default_status

data/app/models/concerns/push_type/templatable.rb

@@ -26,7 +26,7 @@ module PushType
       end
 
       def template_opts
-        { path: 'nodes' }.merge(@template_opts || {})
+        { path: _ct.base_class.name.demodulize.pluralize.underscore }.merge(@template_opts || {})
       end
 
     end

data/app/models/concerns/push_type/unexposable.rb

@@ -4,8 +4,7 @@ module PushType
 
     included do
       scope :exposed, -> {
-        node_types = PushType.unexposed_nodes
-        node_types.present? ? where(['push_type_nodes.type NOT IN (?)', node_types]) : all
+        unexposed_classes.present? ? where.not(type: unexposed_classes) : all
       }
     end
 
@@ -15,12 +14,31 @@ module PushType
 
     module ClassMethods
 
+      def descendants(opts = {})
+        if opts.has_key? :exposed
+          super().select { |d| !opts[:exposed] == PushType.send(unexposure_method).include?(d.name.underscore) }
+        else
+          super()
+        end
+      end
+
+      def unexposed_classes
+        _ct.base_class.descendants(exposed: false)
+      end
+
+      def unexposure_method
+        case _ct.base_class.name.demodulize
+          when 'Node'     then :unexposed_nodes
+          when 'Taxonomy' then :unexposed_taxonomies
+        end
+      end
+
       def unexpose!
-        PushType.config.unexposed_nodes.push(self.name.underscore.to_sym).uniq!
+        PushType.config.send(unexposure_method).push(self.name.underscore.to_sym).uniq!
       end
 
       def exposed?
-        !PushType.unexposed_nodes.include?(self.name)
+        !unexposed_classes.include?(self)
       end
 
     end

data/app/models/push_type/taxonomy.rb

@@ -0,0 +1,39 @@
+module PushType
+  class Taxonomy < ActiveRecord::Base
+
+    include PushType::Templatable
+    include PushType::Unexposable
+
+    acts_as_tree name_column: 'slug', order: 'sort_order', dependent: :destroy
+
+    validates :title, presence: true, uniqueness: { scope: :parent_id }
+    validates :slug,  presence: true, uniqueness: { scope: :parent_id }
+
+    class << self
+      def title
+        @title ||= name.underscore.humanize.pluralize
+      end
+
+      def base_slug(*args)
+        if args.present?
+          @base_slug = args.first
+        else
+          ( @base_slug || name ).to_s.underscore
+        end
+      end
+    end
+
+    def base_slug
+      self.class.base_slug
+    end
+
+    def permalink
+      @permalink ||= self_and_ancestors.map(&:slug).push(base_slug).reverse.join('/')
+    end
+
+    def exposed?
+      self.class.exposed?
+    end
+
+  end
+end

data/db/migrate/20141117170533_create_push_type_users.rb

@@ -6,7 +6,7 @@ class CreatePushTypeUsers < ActiveRecord::Migration
       t.string    :email
       t.jsonb     :field_store
       
-      t.timestamps
+      t.timestamps null: false
     end
   end
 end

data/db/migrate/20141117204630_create_push_type_nodes.rb

@@ -17,7 +17,7 @@ class CreatePushTypeNodes < ActiveRecord::Migration
       t.uuid      :creator_id
       t.uuid      :updater_id
 
-      t.timestamps
+      t.timestamps null: false
       t.datetime  :deleted_at
     end
   end

data/db/migrate/20141117210644_create_push_type_node_hierarchies.rb

@@ -8,9 +8,9 @@ class CreatePushTypeNodeHierarchies < ActiveRecord::Migration
 
     add_index :push_type_node_hierarchies, [:ancestor_id, :descendant_id, :generations],
       unique: true,
-      name: "anc_desc_idx"
+      name: "node_anc_desc_idx"
 
     add_index :push_type_node_hierarchies, [:descendant_id],
-      name: "desc_idx"
+      name: "node_desc_idx"
   end
 end

data/db/migrate/20141127151930_create_push_type_assets.rb

@@ -11,7 +11,7 @@ class CreatePushTypeAssets < ActiveRecord::Migration
 
       t.uuid      :uploader_id
 
-      t.timestamps
+      t.timestamps null: false
       t.datetime  :deleted_at
     end
   end

data/db/migrate/20150310115933_create_push_type_taxonomies.rb

@@ -0,0 +1,18 @@
+class CreatePushTypeTaxonomies < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp' unless extension_enabled?('uuid-ossp')
+    create_table :push_type_taxonomies, id: :uuid, default: 'uuid_generate_v4()'  do |t|
+      t.string    :type
+      t.string    :title
+      t.string    :slug
+
+      t.uuid      :parent_id
+      t.integer   :sort_order
+
+      t.timestamps null: false
+    end
+
+    # Also add a tags array to Assets
+    add_column :push_type_assets, :tags, :string, array: true
+  end
+end

data/db/migrate/20150310123230_create_push_type_taxonomy_hierarchies.rb

@@ -0,0 +1,16 @@
+class CreatePushTypeTaxonomyHierarchies < ActiveRecord::Migration
+  def change
+    create_table :push_type_taxonomy_hierarchies, id: false do |t|
+      t.uuid      :ancestor_id,     null: false
+      t.uuid      :descendant_id,   null: false
+      t.integer   :generations,     null: false
+    end
+
+    add_index :push_type_taxonomy_hierarchies, [:ancestor_id, :descendant_id, :generations],
+      unique: true,
+      name: "taxonomy_anc_desc_idx"
+
+    add_index :push_type_taxonomy_hierarchies, [:descendant_id],
+      name: "taxonomy_desc_idx"
+  end
+end

data/lib/generators/push_type/install/templates/push_type.rb

@@ -6,6 +6,8 @@ PushType.setup do |config|
 
   config.home_slug = 'home'
 
+  config.unexposed_taxonomies = []
+
   config.media_styles = {
     large:    '1024x1024>',
     medium:   '512x512>',

data/lib/generators/push_type/node/node_generator.rb

@@ -5,7 +5,7 @@ module PushType
 
     def create_model
       template 'node.rb', "app/models/#{ file_name }.rb"
-      template 'template.html.erb', "app/views/nodes/#{ file_name }.html.erb"
+      template 'node.html.erb', "app/views/nodes/#{ file_name }.html.erb"
     end
 
     hook_for :test_framework, as: :model

data/lib/generators/push_type/taxonomy/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a model that inherits from PushType::Taxonomy
+
+Example:
+    rails generate push_type:taxonomy category
+
+    This will create:
+        app/models/category.rb

data/lib/generators/push_type/taxonomy/taxonomy_generator.rb

@@ -0,0 +1,13 @@
+module PushType
+  class TaxonomyGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_field
+      template 'taxonomy.rb', "app/models/#{ file_name }.rb"
+      template 'taxonomy.html.erb', "app/views/taxonomies/#{ file_name }.html.erb"
+    end
+
+    hook_for :test_framework, as: :model
+
+  end
+end

data/lib/generators/push_type/taxonomy/templates/taxonomy.html.erb

@@ -0,0 +1,3 @@
+<h1><%%= @taxonomy.title %></h1>
+<p>This is a generated <%= class_name %> template.</p>
+<p>Find me at: app/views/taxonomies/<%= file_name %>.html.erb</p>

data/lib/generators/push_type/taxonomy/templates/taxonomy.rb

@@ -0,0 +1,6 @@
+class <%= class_name %> < PushType::Taxonomy
+
+  # Set base slug
+  # base_slug :<%= file_name %>
+
+end

data/lib/push_type/config.rb

@@ -10,6 +10,9 @@ module PushType
     mattr_accessor :home_slug
     @@home_slug = 'home'
 
+    mattr_accessor :unexposed_taxonomies
+    @@unexposed_taxonomies = []
+
     mattr_accessor :media_styles
     @@media_styles = {
       large:    '1024x1024>',

data/lib/push_type/core.rb

@@ -18,26 +18,26 @@ module PushType
     end
 
     def root_nodes
-      node_types_from_list(config.root_nodes)
+      subclasses_from_list(:node, config.root_nodes)
     end
 
     def unexposed_nodes
-      node_types_from_list(config.unexposed_nodes).map(&:camelcase)
+      subclasses_from_list(:node, config.unexposed_nodes)
     end
 
-    def node_types_from_list(types = nil)
+    def unexposed_taxonomies
+      subclasses_from_list(:taxonomy, config.unexposed_taxonomies)
+    end
+
+    def subclasses_from_list(scope, types = nil)
       return [] unless types
+      descendants = "push_type/#{ scope }".camelcase.constantize.descendants.map { |c| c.name.underscore }
       types_array = Array.wrap(types)
+
       if types_array.include? :all
-        PushType::Node.descendants.map(&:name).map(&:underscore)
+        descendants
       else
-        types_array.map(&:to_s).select do |kind|
-          begin
-            kind.camelcase.constantize.ancestors.include? PushType::Node
-          rescue NameError
-            false
-          end
-        end
+        descendants & types_array.map(&:to_s)
       end.sort
     end
 

data/lib/push_type/rails/routes.rb

@@ -6,7 +6,8 @@ module ActionDispatch::Routing
         path:   '/push_type',
         home:   PushType.config.home_slug,
         actions: {
-          node: 'front_end#node'
+          node:     'nodes_front_end#show',
+          taxonomy: 'taxonomies_front_end#show',
         }
       }.deep_merge!(options)
 
@@ -20,6 +21,11 @@ module ActionDispatch::Routing
         asset.media params[:style]
       }, as: 'media'
 
+      # Taxonomies
+      get ":taxonomy/*permalink" => opts[:actions][:taxonomy], as: 'taxonomy', constraints: ->(params, req) {
+        PushType::Taxonomy.descendants(exposed: true).map(&:base_slug).include? params[:taxonomy]
+      }
+
       # A catch-all root for the nodes
       get '*permalink' => opts[:actions][:node], as: 'node'
       root to: opts[:actions][:node], permalink: opts[:home]

data/lib/push_type/tag_list_query.rb

@@ -12,7 +12,7 @@ module PushType
     end
 
     def node_types
-      PushType.node_types_from_list(@opts[:type]).map { |n| "'#{ n.camelcase }'" }
+      PushType.subclasses_from_list(:node, @opts[:type]).map { |n| "'#{ n.camelcase }'" }
     end
 
     private

data/lib/push_type/testing/common_rake.rb

@@ -1,6 +1,7 @@
 require 'generators/push_type/dummy/dummy_generator'
 require 'generators/push_type/install/install_generator'
 require 'generators/push_type/node/node_generator'
+require 'generators/push_type/taxonomy/taxonomy_generator'
 
 namespace :common do
 
@@ -16,6 +17,7 @@ namespace :common do
       system 'bundle exec rake db:drop db:create'
       PushType::InstallGenerator.start ['--quiet']
       PushType::NodeGenerator.start ['page', '--quiet']
+      PushType::TaxonomyGenerator.start ['category', '--quiet']
     end
   end
 

data/lib/push_type/testing/factories.rb

@@ -1,6 +1,11 @@
 require 'factory_girl_rails'
 
 FactoryGirl.define do
+
+  sequence :title do |n|
+    "Foo Bar #{n}"
+  end
+
   sequence :slug do |n|
     "foo-bar-#{n}"
   end
@@ -37,5 +42,10 @@ FactoryGirl.define do
       file  { Rack::Test::UploadedFile.new(PushType::Core::Engine.root.join('test', 'files/document.pdf')) }
     end
   end
+
+  factory :taxonomy, class: 'PushType::Taxonomy' do
+    title   { generate :title }
+    slug    { generate :slug }
+  end
   
 end

data/lib/push_type/testing/setup.rb

@@ -12,6 +12,9 @@ DatabaseCleaner.clean_with :truncation
 Dragonfly.app.use_datastore :memory
 
 class ActiveSupport::TestCase
+  # Due to test weirdness / dodgy code need to reference some classes
+  Page && Category
+
   before :each do
     DatabaseCleaner.start
     PushType.config.root_nodes = :all

data/lib/push_type/version.rb

@@ -1,3 +1,3 @@
 module PushType
-  VERSION = '0.3.3'
+  VERSION = '0.4.0.beta.3'
 end