storytime 1.2.0 → 2.0.0

data/lib/generators/templates/storytime.rb

@@ -1,64 +1,107 @@
 Storytime.configure do |config|
-  # Name of the layout to be used. e.g. the 'application'
-  # layout uses /app/views/layout/application, in your
-  # host app, as the layout.
-  # config.layout = 'application'
-
   # Name of the model you're using for Storytime users.
-  config.user_class = 'User'
+  <%= @enable_user_class ? nil : '# ' %>config.user_class = '<%= @user_class %>'
 
   # Path of Storytime's dashboard, relative to
   # Storytime's mount point within the host app.
-  # config.dashboard_namespace_path = "/storytime"
-
-  # Path of Storytime's home page, relative to
-  # Storytime's mount point within the host app.
-  # config.home_page_path = "/"
+  <%= @enable_dashboard_namespace_path ? nil : '# ' %>config.dashboard_namespace_path = '<%= @dashboard_namespace_path %>'
 
   # Path used to sign users in. 
   # config.login_path = '/users/sign_in'
 
-  # Path used to log users out. 
-  # config.logout_path = '/users/sign_out'
-
   # Method used for Storytime user logout path.
   # config.logout_method = :delete
 
   # Add custom post types to use within Storytime.
   # Make sure that the custom post types inherit the
   # from the Storytime::Post class.
-  # config.post_types += ['CustomPostType']
+  <%= @enable_post_types ? nil : '# ' %>config.post_types += <%= @post_types %>
 
   # Character limit for Storytime::Post.title <= 255
-  # config.post_title_character_limit = 255
+  <%= @enable_post_title_character_limit ? nil : '# ' %>config.post_title_character_limit = <%= @post_title_character_limit %>
 
   # Character limit for Storytime::Post.excerpt
-  # config.post_excerpt_character_limit = 500
+  <%= @enable_post_excerpt_character_limit ? nil : '# ' %>config.post_excerpt_character_limit = <%= @post_excerpt_character_limit %>
 
-  # Array of tags to allow from the Summernote WYSIWYG Editor.
-  # An empty array or nil setting will allow all tags.
-  # config.whitelisted_html_tags = %w(p blockquote pre h1 h2 h3 h4 h5 h6 span ul li ol table tbody td br a img iframe hr)
+  # Hook for handling post content sanitization.
+  # Accepts either a Lambda or Proc which can be used to
+  # handle how post content is sanitized (i.e. which tags,
+  # HTML attributes to allow/disallow.
+  # config.post_sanitizer = Proc.new do |draft_content|
+  #   white_list_sanitizer = if Rails::VERSION::MINOR <= 1
+  #     HTML::WhiteListSanitizer.new
+  #   else
+  #     Rails::Html::WhiteListSanitizer.new
+  #   end
+  #
+  #   attributes = %w(
+  #     id class href style src title width height alt value 
+  #     target rel align disabled
+  #   )
+  #
+  #   if Storytime.whitelisted_post_html_tags.blank?
+  #     white_list_sanitizer.sanitize(draft_content, attributes: attributes)
+  #   else
+  #     white_list_sanitizer.sanitize(draft_content,
+  #                                   tags: Storytime.whitelisted_post_html_tags,
+  #                                   attributes: attributes)
+  #   end
+  # end
 
   # Enable Disqus comments using your forum's shortname,
   # the unique identifier for your website as registered on Disqus.
-  # config.disqus_forum_shortname = ""
+  <%= @enable_disqus_forum_shortname ? nil : '# ' %>config.disqus_forum_shortname = '<%= @disqus_forum_shortname %>'
+
+  # Enable Discourse comments using your discourse server,
+  # Your discourse server must be configured for embedded comments.
+  # e.g. config.discourse_name = "http://forum.example.com"
+  # NOTE:  include the '/' suffix at the end of the url
+  <%= @enable_discourse_name ? nil : '# ' %>config.discourse_name = '<%= @discourse_name %>'
 
   # Email regex used to validate email format validity for subscriptions.
-  # config.email_regexp = /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/
+  <%= @enable_email_regexp ? nil : '# ' %>config.email_regexp = <%= @email_regexp %>
 
   # Search adapter to use for searching through Storytime Posts or
   # Post subclasses. Options for the search adapter include:
   # Storytime::PostgresSearchAdapter, Storytime::MysqlSearchAdapter,
   # Storytime::MysqlFulltextSearchAdapter, Storytime::Sqlite3SearchAdapter
-  # config.search_adapter = ''
+  <%= @enable_search_adapter ? nil : '# ' %>config.search_adapter = <%= @search_adapter %>
+
+  # Hook for handling notification delivery when publishing content.
+  # Accepts either a Lambda or Proc which can be set up to schedule
+  # an ActiveJob (Rails 4.2+), for example:
+  # 
+  # config.on_publish_with_notifications = Proc.new do |post|
+  #   wait_until = post.published_at + 1.minute
+  #   StorytimePostNotificationJob.set(wait_until: wait_until).perform_later(post.id)
+  # end
+  # 
+  ### In app/jobs/storytime_post_notification_job.rb:
+  # class StorytimePostNotificationJob < ActiveJob::Base
+  #   queue_as :mailers
+  # 
+  #   def perform(post_id)
+  #     Storytime::PostNotifier.send_notifications_for(post_id)
+  #   end
+  # end
+  config.on_publish_with_notifications = nil
 
   # File upload options.
-  config.enable_file_upload = true
+  config.enable_file_upload = <%= @enable_file_upload %>
+
+  # AWS Region to use for file uploads.
+  # config.aws_region = <%= @aws_region %>
+
+  # AWS Access Key ID to use for file uploads.
+  # config.aws_access_key_id = <%= @aws_access_key_id %>
+
+  # AWS Secret Key to use for file uploads.
+  # config.aws_secret_key = <%= @aws_secret_key %>
 
   if Rails.env.production?
-    config.s3_bucket = 'my-s3-bucket'
-    config.media_storage = :s3
+    config.media_storage = <%= @prod_media_storage %>
+    <%= @enable_file_upload && @prod_media_storage == ':s3' ? nil : '# ' %>config.s3_bucket = '<%= @s3_bucket %>'
   else
-    config.media_storage = :file
+    config.media_storage = <%= @dev_media_storage %>
   end
 end

data/lib/storytime/cli/install.rb

@@ -0,0 +1,274 @@
+module Storytime
+  class CLI < Thor
+    class Install
+      class << self
+        include Thor::Actions
+        include Thor::Shell
+
+        def options; {}; end
+
+        def storytime_defaults
+          hash = {}
+          hash[:user_class] = 'User'
+          hash[:dashboard_namespace_path] = '/storytime'
+          hash[:post_types] = ['CustomPostType']
+          hash[:post_title_character_limit] = 100
+          hash[:post_excerpt_character_limit] = 500
+          hash[:email_regexp] = '/\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/'
+          hash[:search_adapter] = "''"
+          hash[:enable_file_upload] = true
+          hash[:aws_region] = "ENV['STORYTIME_AWS_REGION']"
+          hash[:aws_access_key_id] = "ENV['STORYTIME_AWS_ACCESS_KEY_ID']"
+          hash[:aws_secret_key] = "ENV['STORYTIME_AWS_SECRET_KEY']"
+          hash[:s3_bucket] = 'my-s3-bucket'
+          hash[:prod_media_storage] = ':s3'
+          hash[:dev_media_storage] = ':file'
+          hash
+        end
+
+        def automated
+          `bin/spring stop`
+
+          defaults = storytime_defaults
+          self.destination_root = File.expand_path("./")
+
+          say "Starting install of Storytime...", :cyan
+
+          say "Setting up Storytime engine mount point...", :cyan
+          inject_storytime_mount("/")
+          say "Storytime mount point added to routes file\n\n", :green
+
+          say "Setting up Storytime initializer file...", :cyan
+          Storytime::Generators::Initializer.start [storytime_defaults]
+          say "Finished setting up Storytime initializer.\n\n", :green
+
+          check_user_model(defaults[:user_class])
+          add_storytime_user(defaults[:user_class])
+          copy_migrations
+          migrate_db
+          copy_views
+
+          say "Finished installing Storytime.", :green
+          say "Start up your Rails server and navigate to http://localhost:3000#{defaults[:mount_point]} to use Storytime.", :green
+        end
+
+        def inject_storytime_mount(mount_point)
+          inject_into_file "config/routes.rb", "\n  mount Storytime::Engine => '#{mount_point}'\n", :before => /^end/
+        end
+
+        def interactive
+          `bin/spring stop`
+
+          begin
+            require File.expand_path('config/environment.rb')
+          rescue LoadError
+            say "This command must be run from the root directory of a Rails app... Change directories and try again.", :red
+            return
+          end
+
+          say "Starting install of Storytime...", :cyan
+
+          mount_point = add_storytime_mount
+          init_hash = setup_initializer_file(mount_point)
+          check_user_model(init_hash[:user_class])
+          add_storytime_user(init_hash[:user_class])
+          copy_migrations
+          migrate_db unless no? "Would you like to migrate your database now? [y/n] (y)", :yellow
+          copy_views unless no? "Would you like to copy Storytime's views to your host app? [y/n] (y)", :yellow
+
+          say "Finished installing Storytime.", :green
+          say "Start up your Rails server and navigate to http://localhost:3000#{mount_point} to use Storytime.", :green
+        end
+
+        def add_storytime_mount
+          self.destination_root = File.expand_path("./")
+          
+          say "Setting up Storytime engine mount point...", :cyan
+          mount_point = ask "Where would you like to mount Storytime within the host app? (/)", :yellow
+
+          if mount_point.blank?
+            mount_point = "/"
+          elsif mount_point[0] != "/" 
+            mount_point.prepend("/")
+          end
+
+          inject_storytime_mount(mount_point)
+
+          say "Storytime mount point added to routes file\n\n", :green
+
+          return mount_point
+        end
+
+        def setup_initializer_file(mount_point)
+          init_hash = storytime_defaults
+
+          say "Setting up Storytime initializer file...", :cyan
+
+          # User Class
+          user_class = ask "Name of the model that you want to use for Storytime users? (User)", :yellow
+
+          unless user_class.blank?
+            init_hash[:user_class] = user_class.camelize
+            init_hash[:enable_user_class] = true
+          end
+
+          # Admin Models
+          if yes? "Do you want to enable certain models to be accessible to CRUD operations within the Storytime admin dashboard? [y/n] (n)", :yellow
+            admin_models = ask "Enter a comma separated list of the models that you want to be CRUD accessible within the admin dashboard:", :yellow
+
+            unless admin_models.blank?
+              admin_models = admin_models.gsub(" ", "").split(",")
+
+              admin_models.each do |model|
+                say "Creating a StorytimeAdmin controller for #{model}...", :cyan
+                `bin/rails g storytime_admin:resource #{model}`
+              end
+            end
+          end
+
+          # Dashboard Namespace Path
+          if no? "Do you want to use /storytime as the location of the dashboard? [y/n] (y)", :yellow
+            dashboard_namespace_path = ask "Path of Storytime's dashboard, relative to Storytime's mount point, #{mount_point}, within the host app? (/storytime)", :yellow
+
+            init_hash[:dashboard_namespace_path] = dashboard_namespace_path unless dashboard_namespace_path.blank?
+            init_hash[:enable_dashboard_namespace_path] = true
+          end
+          
+          # Custom Post Types
+          if yes? "Do you want to use additional post types other than Storytime::Page and Storytime::BlogPost? [y/n] (n)", :yellow
+            post_types = ask "Enter a comma separated list of additional post types that you'd like to use:", :yellow
+
+            unless post_types.blank?
+              post_types = post_types.gsub(",", " ")
+
+              init_hash[:post_types] = "%w(#{post_types})"
+              init_hash[:enable_post_types] = true
+            end
+          end
+          
+          # Post Title Character Limit
+          post_title_character_limit = ask "What should the character limit be for post titles? (100)", :yellow
+
+          if post_title_character_limit.to_i > 0
+            if post_title_character_limit.to_i > 255
+              say "Character limit amount exceeds database maximum - setting limit to default/maximum amount (255).", :red
+              init_hash[:post_title_character_limit] = 255
+            else
+              init_hash[:post_title_character_limit] = post_title_character_limit.to_i
+            end
+            
+            init_hash[:enable_post_title_character_limit] = true
+          elsif !post_title_character_limit.blank?
+            say "Character limit amount is not a valid integer... using the default value (255)", :red
+          end
+          
+          # Post Excerpt Character Limit
+          post_excerpt_character_limit = ask "What should the character limit be for post excerpts? (500)", :yellow
+
+          if post_excerpt_character_limit.to_i > 0
+            init_hash[:post_excerpt_character_limit] = post_excerpt_character_limit.to_i
+            init_hash[:enable_post_excerpt_character_limit] = true
+          elsif !post_excerpt_character_limit.blank?
+            say "Character limit amount is not a valid integer... using the default value (500) instead.", :red
+          end
+
+          # Search Adapters
+          app_database = ask "What database is being used to run this application?", :yellow, :limited_to => ["mysql", "postgres", "sqlite3", "other"]
+          
+          if app_database == "other"
+            say "Note: This app will not be able to use Storytime's search feature.", :red
+          else
+            init_hash[:enable_search_adapter] = true
+          end
+
+          if app_database == "mysql"
+            if yes? "Does this version support Full-Text search (MySql v5.6.4+)? [y/n] (n)", :yellow
+              init_hash[:search_adapter] = Storytime::MysqlFulltextSearchAdapter
+            else
+              init_hash[:search_adapter] = Storytime::MysqlSearchAdapter
+            end
+          elsif app_database == "postgres"
+            init_hash[:search_adapter] = Storytime::PostgresSearchAdapter
+          elsif app_database == "sqlite3"
+            init_hash[:search_adapter] = Storytime::Sqlite3SearchAdapter
+          end
+
+          # Enable File Upload
+          unless no? "Do you want to enable file uploads? [y/n] (y)", :yellow
+            init_hash[:enable_file_upload] = true
+
+            prod_media_storage = ask "What type of storage do you want to use for production environments?", :yellow, :limited_to => [":file", ":s3"]
+            init_hash[:prod_media_storage] = prod_media_storage
+
+            if prod_media_storage == ":s3"
+              s3_bucket = ask "What's the name of your S3 bucket?", :yellow
+              
+              if s3_bucket.blank?
+                say "No S3 bucket was listed... using default (my-s3-bucket) instead. Forgetting to change this before deploying to your production environment WILL result in broken uploads.", :red
+              else
+                init_hash[:s3_bucket] = s3_bucket
+              end
+            end
+          else
+            init_hash[:prod_media_storage] = ":file"
+            init_hash[:enable_file_upload] = false
+          end
+          
+          Storytime::Generators::Initializer.start [init_hash]
+
+          say "Finished setting up Storytime initializer.\n\n", :green
+
+          return init_hash
+        end
+
+        def check_user_model(user_class)
+          unless File.exists?("app/models/#{user_class.underscore}.rb")
+            unless File.exists?("config/initializers/devise.rb")
+              say "Devise initializer not found... trying to generate one.", :red
+
+              `bin/rails generate devise:install`
+            end
+            
+            say "No #{user_class} model was found... creating one using Devise.", :red
+
+            `bin/rails generate devise #{user_class}`
+          end
+        end
+
+        def add_storytime_user(user_class)
+          self.destination_root = File.expand_path("./")
+
+          say "Adding `storytime_user` to #{user_class} class...", :cyan
+
+          inject_into_file "app/models/#{user_class.underscore}.rb", "\n  storytime_user\n", :before => /^end/
+
+          say "`storytime_user` added to #{user_class} class.\n\n", :green
+        end
+
+        def copy_migrations
+          say "Copying over Storytime migrations...", :cyan
+
+          `bin/rake storytime:install:migrations`
+
+          say "Finished copying Storytime migrations.\n\n", :green
+        end
+
+        def migrate_db
+          say "Running database migrations...", :cyan
+
+          `bin/rake db:migrate`
+
+          say "Finished running database migrations.\n\n", :green
+        end
+
+        def copy_views
+          say "Copying Storytime views...", :cyan
+
+          `bin/rails generate storytime:views`
+
+          say "Finished copying Storytime views.\n\n", :green
+        end
+      end
+    end
+  end
+end

data/lib/storytime/cli.rb

@@ -0,0 +1,28 @@
+require 'thor'
+require 'storytime'
+require 'storytime/version'
+
+require 'storytime/cli/install'
+require 'storytime/generators/initializer'
+
+module Storytime
+  class CLI < Thor
+    package_name 'Storytime'
+    map '-v' => :version
+
+    desc 'install', 'Install Storytim in current Rails 4.0+ app'
+    option :use_defaults, :aliases => '-d', :type => :boolean, :default => false, :desc => 'install Storytime using default settings and no prompts'
+    def install
+      if options[:use_defaults]
+        Storytime::CLI::Install.automated
+      else
+        Storytime::CLI::Install.interactive 
+      end
+    end
+
+    desc 'version', 'Show version of Storytime'
+    def version
+      puts "Storytime v#{Storytime::VERSION}"
+    end
+  end
+end

data/lib/storytime/concerns/current_site.rb

@@ -0,0 +1,10 @@
+module Storytime
+  module Concerns
+    module CurrentSite
+      def current_storytime_site(req = nil)
+        req ||= request if respond_to?(:request)
+        @current_storytime_site = Storytime::Site.find_by(custom_domain: req.host) || Storytime::Site.first
+      end
+    end
+  end
+end

data/lib/storytime/concerns/has_versions.rb

@@ -37,12 +37,28 @@ module Storytime
       end
 
       def publish!
+        self.published = "1"
         attrs = {self.class.draft_content_column => self.latest_version.content}
-        attrs[:published_at] = Time.now if published_at.blank?
         self.update_columns(attrs)
       end
 
       def published=(val)
+        if val == "1" || val == "true" || val == true
+          if self.published_at_date || self.published_at_time
+            self.published_at = if self.published_at_time.nil?
+              DateTime.parse "#{self.published_at_date}"
+            elsif self.published_at_date.nil?
+              DateTime.parse "#{Date.today} #{self.published_at_time}"
+            else
+              DateTime.parse "#{self.published_at_date} #{self.published_at_time}"
+            end
+          else
+            self.published_at = Time.now unless self.published_at
+          end
+        else
+          self.published_at_date = nil
+          self.published_at_time = nil
+        end
       end
 
       def published
@@ -56,13 +72,16 @@ module Storytime
       included do
         has_many :versions, as: :versionable, dependent: :destroy
         cattr_accessor :draft_content_column
-        attr_accessor :draft_user_id
+        attr_accessor :draft_user_id, :published_at_date, :published_at_time
         attr_writer :draft_content, :draft_version_id
         after_save :create_version, :activate_version
 
         self.draft_content_column = :content
 
-        scope :published, -> { where("published_at is not null") }
+        validates_presence_of :draft_content
+
+        scope :published, -> { where("published_at IS NOT NULL").where("published_at <= ?", Time.now) }
+        scope :draft, -> { where("published_at IS NULL OR published_at > ?", Time.now) }
       end
 
       module ClassMethods

data/lib/storytime/concerns/storytime_user.rb

@@ -5,7 +5,9 @@ module Storytime
 
       module ClassMethods
         def storytime_user
-          belongs_to :storytime_role, class_name: "Storytime::Role"
+          has_many :storytime_memberships, class_name: "::Storytime::Membership", dependent: :destroy
+          has_many :storytime_roles, through: :storytime_memberships
+          has_many :storytime_sites, through: :storytime_memberships, source: :site
           
           has_many :storytime_posts, class_name: "Storytime::Post"
           has_many :storytime_pages, class_name: "Storytime::Page"
@@ -13,26 +15,48 @@ module Storytime
           has_many :storytime_versions, class_name: "Storytime::Version"
           has_many :storytime_comments, class_name: "Storytime::Comment"
 
+          accepts_nested_attributes_for :storytime_memberships, allow_destroy: true
+
+          scope :non_members, ->(site) { all.reject{|user| user.storytime_user?(site)} }
+
+          include Storytime::Concerns::StorytimeUser::LocalInstanceMethods
+
           class_eval <<-EOS
             def self.policy_class
               UserPolicy
             end
-
-            def storytime_user?
-              !storytime_role.nil?
-            end
           EOS
 
           %w{admin editor writer}.each do |role_name|
             class_eval <<-EOS
-              def storytime_#{role_name}?
-                storytime_role && storytime_role.name == "#{role_name}"
+              def storytime_#{role_name}?(site)
+                role = storytime_role_in_site(site)
+                role && role.name == "#{role_name}"
               end
             EOS
           end  
         end
       end
 
+      module LocalInstanceMethods
+        def storytime_name
+          self[:storytime_name] || email
+        end
+
+        def storytime_user?(site)
+          storytime_memberships.find_by(site: site).present?
+        end
+
+        def storytime_role_in_site(site)
+          if membership = storytime_membership_in_site(site)
+            membership.storytime_role
+          end
+        end
+
+        def storytime_membership_in_site(site)
+          storytime_memberships.find_by(site: site)
+        end
+      end
     end
   end
 end

data/lib/storytime/constraints/blog_constraint.rb

@@ -0,0 +1,11 @@
+module Storytime
+  module Constraints
+    class BlogConstraint
+      include Storytime::Concerns::CurrentSite
+      
+      def matches?(request)
+        current_storytime_site(request).blogs.friendly.exists?(request.params[:id])
+      end
+    end
+  end
+end

data/lib/storytime/constraints/blog_homepage_constraint.rb

@@ -0,0 +1,11 @@
+module Storytime
+  module Constraints
+    class BlogHomepageConstraint
+      include Storytime::Concerns::CurrentSite
+      def matches?(request)
+        site = current_storytime_site(request)
+        site.present? && site.homepage.present? && site.homepage.is_a?(Storytime::Blog)
+      end
+    end
+  end
+end

data/lib/storytime/constraints/page_constraint.rb

@@ -0,0 +1,13 @@
+module Storytime
+  module Constraints
+    class PageConstraint
+      include Storytime::Concerns::CurrentSite
+      
+      def matches?(request)
+        site = current_storytime_site(request)
+        site.pages.friendly.exists?(request.params[:id]) ||
+        File.exists?(Rails.root.join('app', 'views', "storytime/#{site.custom_view_path}/pages/#{ActionController::Base.helpers.sanitize(request.params[:id])}.html.erb"))
+      end
+    end
+  end
+end

data/lib/storytime/constraints/page_homepage_constraint.rb

@@ -0,0 +1,11 @@
+module Storytime
+  module Constraints
+    class PageHomepageConstraint
+      include Storytime::Concerns::CurrentSite
+      def matches?(request)
+        site = current_storytime_site(request)
+        site.present? && site.homepage.present? && site.homepage.is_a?(Storytime::Page)
+      end
+    end
+  end
+end