push_type_core 0.1.0.beta3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e5cfc57c3068c45c73376c6905e192f03321f06
+  data.tar.gz: 04013f98749da8c8a5be4902c7041fbae14c79d5
+SHA512:
+  metadata.gz: 291069e98b7024375031e14c0abfd2aec2d01e904c2e24ac9fbb1a011b5f1ca91a04a917c8e85c567f5d267e88599ed3e8d69c08a5fe369903938b3198776ab5
+  data.tar.gz: 7eb951c044e25becd8ce2764713aec11e669b43d4cc5a9308adae8c8ee23063cf3585f7f5c617379878cbeb0eab108c42e75a16268341c26b46a64437ad45fdc

data/LICENSE.md

@@ -0,0 +1,22 @@
+# PushType License
+
+Copyright 2014 Push Code Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# PushType-Core
+
+This project rocks and uses MIT-LICENSE.

data/app/controllers/push_type/application_controller.rb

@@ -0,0 +1,4 @@
+module PushType
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/push_type/front_end_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "push_type/application_controller"
+
+module PushType
+  class FrontEndController < ApplicationController
+
+    before_filter :load_node, only: :node
+
+    def node
+      render *@node.template_args
+    end
+
+    private
+
+    def load_node
+      @node = PushType::Node.published.find_by_path params[:permalink].split('/')
+      raise ActiveRecord::RecordNotFound unless @node
+      instance_variable_set "@#{ @node.type.underscore }", @node
+    end
+    
+  end
+end

data/app/fields/push_type/date_field.rb

@@ -0,0 +1,11 @@
+module PushType
+  class DateField < PushType::FieldType
+    def form_helper
+      @opts[:form_helper] || :date_field
+    end
+
+    def from_json(val)
+      val.to_date
+    end
+  end
+end

data/app/fields/push_type/number_field.rb

@@ -0,0 +1,15 @@
+module PushType
+  class NumberField < PushType::FieldType
+    def form_helper
+      @opts[:form_helper] || :number_field
+    end
+
+    def to_json(val)
+      val.to_i
+    end
+
+    def from_json(val)
+      val.to_i
+    end
+  end
+end

data/app/fields/push_type/rich_text_field.rb

@@ -0,0 +1,10 @@
+module PushType
+  class RichTextField < PushType::FieldType
+    def form_helper
+      :text_area
+    end
+    def html_options
+      super.merge(class: 'froala')
+    end
+  end
+end

data/app/fields/push_type/string_field.rb

@@ -0,0 +1,4 @@
+module PushType
+  class StringField < PushType::FieldType
+  end
+end

data/app/fields/push_type/text_field.rb

@@ -0,0 +1,7 @@
+module PushType
+  class TextField < PushType::FieldType
+    def form_helper
+      @opts[:form_helper] || :text_area
+    end
+  end
+end

data/app/helpers/push_type/application_helper.rb

@@ -0,0 +1,4 @@
+module PushType
+  module ApplicationHelper
+  end
+end

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

@@ -0,0 +1,56 @@
+module PushType
+  module FieldStore
+    extend ActiveSupport::Concern
+
+    def fields
+      self.class.fields
+    end
+
+    module ClassMethods
+
+      attr_reader :fields
+
+      def fields
+        @fields ||= ActiveSupport::OrderedHash.new
+      end
+
+      def field(name, *args)
+        raise ArgumentError if args.size > 2
+        kind, opts = case args.size
+          when 2 then args
+          when 1 then args[0].is_a?(Hash) ? args.insert(0, :string) : args.insert(-1, {})
+          else        [ :string, {} ]
+        end
+
+        fields[name] = field_factory(kind).new(name, opts)
+        store_accessor :field_store, name
+
+        validates name, opts[:validates] if opts[:validates]
+        
+        override_accessor fields[name]
+      end
+
+      protected
+
+      def field_factory(kind)
+        begin
+          "push_type/#{ kind }_field".camelize.constantize
+        rescue NameError
+          "#{ kind }_field".camelize.constantize
+        end
+      end
+
+      def override_accessor(f)
+        define_method "#{f.name}=".to_sym do |val|
+          return unless val
+          super f.to_json(val)
+        end
+        define_method f.name do
+          return unless val = super()
+          f.from_json val
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module PushType
+  module Nestable
+    extend ActiveSupport::Concern
+
+    def child_node_types
+      self.class.child_node_types
+    end
+
+    module ClassMethods
+
+      def child_node_types
+        types = @child_node_types || PushType.config.root_node_types
+        PushType.node_types_from_list(types)
+      end
+
+      def has_child_nodes(*args)
+        @child_node_types = args
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,33 @@
+module PushType
+  module Templatable
+    extend ActiveSupport::Concern
+
+    def template
+      self.class.template_name
+    end
+
+    def template_args
+      [template, self.class.template_opts.except!(:path, :template)]
+    end
+
+    module ClassMethods
+
+      def template(name, opts = {})
+        @template_opts = opts.merge(template: name)
+      end
+
+      def template_name
+        File.join template_opts[:path], template_opts[:template]
+      end
+
+      def template_opts
+        {
+          path:     'nodes',
+          template: self.name.underscore
+        }.merge(@template_opts || {})
+      end
+
+    end
+
+  end  
+end

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

@@ -0,0 +1,23 @@
+module PushType
+  module Trashable
+    extend ActiveSupport::Concern
+
+    included do
+      scope :not_trash, -> { where(deleted_at: nil) }
+      scope :trashed,   -> { where('deleted_at IS NOT NULL') }
+    end
+
+    def trash!
+      update_attribute :deleted_at, Time.zone.now
+    end
+
+    def restore!
+      update_attribute :deleted_at, nil
+    end
+
+    def trashed?
+      deleted_at.present?
+    end
+
+  end  
+end

data/app/models/push_type/asset.rb

@@ -0,0 +1,61 @@
+module PushType
+  class Asset < ActiveRecord::Base
+
+    include PushType::Trashable
+
+    dragonfly_accessor :file
+
+    belongs_to :uploader, class_name: 'PushType::User'
+
+    validates :file, presence: true
+
+    default_scope { order(created_at: :desc) }
+
+    before_create :set_mime_type
+    after_destroy :destroy_file!
+
+    def kind
+      return nil unless file_stored?
+      case mime_type
+        when /\Aaudio\/.*\z/ then :audio
+        when /\Aimage\/.*\z/ then :image
+        when /\Avideo\/.*\z/ then :video
+        else :document
+      end
+    end
+
+    [:audio, :image, :video].each do |k|
+      define_method("#{k}?".to_sym) { kind == k }
+    end
+
+    def description_or_file_name
+      description? ? description : file_name
+    end
+
+    def preview_thumb_url(args = ['300x300#'])
+      return nil unless file_stored?
+      if image?
+        file.thumb(*args).url
+      else
+        "push_type/icon-file-#{ kind }.png"
+      end
+    end
+
+    def as_json(options = nil)
+      options = { only: [:id, :file_name, :file_size, :mime_type, :created_at], methods: [:new_record?, :image?, :description_or_file_name, :preview_thumb_url] } if options.empty?
+      super(options)
+    end
+
+    private
+
+    def set_mime_type
+      self.file_ext   = file.ext
+      self.mime_type  = file.mime_type
+    end
+
+    def destroy_file!
+      self.file.destroy!
+    end
+
+  end
+end

data/app/models/push_type/node.rb

@@ -0,0 +1,57 @@
+module PushType
+  class Node < ActiveRecord::Base
+
+    include PushType::FieldStore
+    include PushType::Nestable
+    include PushType::Templatable
+    include PushType::Trashable
+
+    belongs_to :creator, class_name: 'PushType::User'
+    belongs_to :updater, class_name: 'PushType::User'
+
+    enum status: [ :draft, :published ]
+
+    acts_as_tree name_column: 'slug', order: 'sort_order'
+
+    validates :title, presence: true
+    validates :slug,  presence: true, uniqueness: { scope: :parent_id }
+
+    scope :published, -> {
+      not_trash.where(['push_type_nodes.status = ? AND push_type_nodes.published_at <= ?', Node.statuses[:published], Time.zone.now]).
+        where(['push_type_nodes.published_to IS NULL OR push_type_nodes.published_to > ?', Time.zone.now])
+    }
+
+    after_initialize :default_values
+    before_save :set_published_at
+
+    def permalink
+      @permalink ||= self_and_ancestors.map(&:slug).reverse.join('/')
+    end
+
+    def published?
+      super and !scheduled? and !expired?
+    end
+
+    def scheduled?
+      published_at? and published_at > Time.zone.now
+    end
+
+    def expired?
+      published_to? and published_to < Time.zone.now
+    end
+
+    private
+
+    def default_values
+      self.status ||= Node.statuses[:draft]
+    end
+
+    def set_published_at
+      case status
+        when 'draft', Node.statuses[:draft]         then self.published_at = nil
+        when 'published', Node.statuses[:published] then self.published_at ||= Time.zone.now
+      end
+    end
+    
+  end
+end

data/app/models/push_type/user.rb

@@ -0,0 +1,18 @@
+module PushType
+  class User < ActiveRecord::Base
+
+    include PushType::FieldStore
+
+    validates :name, presence: true
+    validates :email, presence: true, uniqueness: true
+
+    default_scope { order(:name) }
+
+    def initials
+      chunks = name ? name.split(' ') : []
+      chunks.slice!(1..-2)
+      chunks.map { |n| n[0] }.join.upcase
+    end
+    
+  end
+end

data/app/views/layouts/push_type/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PushType</title>
+  <%= stylesheet_link_tag    "push_type/application", media: "all" %>
+  <%= javascript_include_tag "push_type/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/dragonfly.rb

@@ -0,0 +1,24 @@
+# Configure
+Dragonfly.app.configure do
+  plugin :imagemagick
+
+  secret "6fa0d3bcb6c44e897ca39a48eb86eb6262e4351bd0311674ff350ebaeb08c982"
+
+  url_format "/media/:job/:name"
+
+  datastore :file,
+    root_path: Rails.root.join('public/system/dragonfly', Rails.env),
+    server_root: Rails.root.join('public')
+end
+
+# Logger
+Dragonfly.logger = Rails.logger
+
+# Mount as middleware
+Rails.application.middleware.use Dragonfly::Middleware
+
+# Add model functionality
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend Dragonfly::Model
+  ActiveRecord::Base.extend Dragonfly::Model::Validations
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+PushType::Core::Engine.routes.draw do
+end

data/db/migrate/20141117170533_create_push_type_users.rb

@@ -0,0 +1,12 @@
+class CreatePushTypeUsers < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp' unless extension_enabled?('uuid-ossp')
+    create_table :push_type_users, id: :uuid, default: 'uuid_generate_v4()' do |t|
+      t.string    :name
+      t.string    :email
+      t.json      :field_store
+      
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20141117204630_create_push_type_nodes.rb

@@ -0,0 +1,24 @@
+class CreatePushTypeNodes < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp' unless extension_enabled?('uuid-ossp')
+    create_table :push_type_nodes, id: :uuid, default: 'uuid_generate_v4()' do |t|
+      t.string    :type
+      t.string    :title
+      t.string    :slug
+      t.json      :field_store
+
+      t.uuid      :parent_id
+      t.integer   :sort_order
+
+      t.integer   :status
+      t.datetime  :published_at
+      t.datetime  :published_to
+
+      t.uuid      :creator_id
+      t.uuid      :updater_id
+
+      t.timestamps
+      t.datetime  :deleted_at
+    end
+  end
+end

data/db/migrate/20141117210644_create_push_type_node_hierarchies.rb

@@ -0,0 +1,16 @@
+class CreatePushTypeNodeHierarchies < ActiveRecord::Migration
+  def change
+    create_table :push_type_node_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_node_hierarchies, [:ancestor_id, :descendant_id, :generations],
+      unique: true,
+      name: "anc_desc_idx"
+
+    add_index :push_type_node_hierarchies, [:descendant_id],
+      name: "desc_idx"
+  end
+end

data/db/migrate/20141127151930_create_push_type_assets.rb

@@ -0,0 +1,18 @@
+class CreatePushTypeAssets < ActiveRecord::Migration
+  def change
+    enable_extension 'uuid-ossp' unless extension_enabled?('uuid-ossp')
+    create_table :push_type_assets, id: :uuid, default: 'uuid_generate_v4()' do |t|
+      t.string    :file_uid
+      t.string    :file_name
+      t.integer   :file_size
+      t.string    :file_ext
+      t.string    :mime_type
+      t.string    :description
+
+      t.uuid      :uploader_id
+
+      t.timestamps
+      t.datetime  :deleted_at
+    end
+  end
+end

data/lib/generators/push_type/dummy/dummy_generator.rb

@@ -0,0 +1,56 @@
+require "rails/generators/rails/app/app_generator"
+
+module PushType
+  class PushType::DummyGenerator < Rails::Generators::Base
+    desc "Creates blank Rails application and installs PushType"
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    class_option :lib_name, default: 'push_type_core'
+    class_option :path,     default: 'test/dummy'
+
+    def clean_up_test_dummy
+      remove_dir(dummy_path) if File.directory?(dummy_path)
+    end
+
+    PASSTHROUGH_OPTIONS = [
+      :skip_active_record, :skip_javascript, :database, :javascript, :quiet, :pretend, :force, :skip
+    ]
+
+    def generate_test_dummy
+      opts = {}.merge(options).slice(*PASSTHROUGH_OPTIONS)
+      opts[:database]       = 'postgresql'
+      opts[:force]          = true
+      opts[:skip_git]       = true
+      opts[:skip_keeps]     = true
+      opts[:skip_gemfile]   = true
+      opts[:skip_bundle]    = true
+
+      puts "Generating dummy Rails application... (#{options[:lib_name]})"
+      invoke Rails::Generators::AppGenerator, [ File.expand_path(dummy_path, destination_root) ], opts
+    end
+
+    def test_dummy_config
+      template  'application.rb', "#{ dummy_path }/config/application.rb",  force: true
+      copy_file 'boot.rb',        "#{ dummy_path }/config/boot.rb",         force: true
+      #copy_file 'page.rb',        "#{ dummy_path }/app/models/page.rb",     force: true
+    end
+
+    def clean_test_dummy
+      remove_file "#{ dummy_path }/test"
+      remove_file "#{ dummy_path }/vendor"
+    end
+
+    protected
+
+    def dummy_path
+      options[:path]
+    end
+
+    def lib_name
+      options[:lib_name]
+    end
+
+  end
+end
+

data/lib/generators/push_type/dummy/templates/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+
+require '<%= lib_name %>'
+
+module Dummy
+  class Application < Rails::Application
+    config.action_mailer.default_url_options = { host: 'localhost:3000' }
+  end
+end
+

data/lib/generators/push_type/dummy/templates/boot.rb

@@ -0,0 +1,4 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/lib/generators/push_type/dummy/templates/page.rb

@@ -0,0 +1,6 @@
+class Page < PushType::Node
+
+  field :description
+  field :body, :rich_text, validates: { presence: true }
+
+end

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

@@ -0,0 +1,28 @@
+module PushType
+  class PushType::InstallGenerator < Rails::Generators::Base
+    desc "Install and configure PushType for this application"
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    class_option :migrate, type: :boolean, default: true
+
+    def create_push_type_initializer
+      copy_file 'push_type.rb', 'config/initializers/push_type.rb'
+    end
+
+    def inject_push_type_routes
+      inject_into_file 'config/routes.rb', "\n\n  mount_push_type\n", after: 'Rails.application.routes.draw do', verbose: true
+    end
+
+    def install_migrations
+      rake 'railties:install:migrations'
+    end
+
+    def run_migrations
+      if options[:migrate]
+        rake 'db:migrate'
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+PushType.setup do |config|
+
+  config.root_node_types = :all
+
+end

data/lib/generators/push_type/node/USAGE

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

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

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