outpost-publishing 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in outpost-publishing.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Bryan Ricker
+
+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,70 @@
+# Outpost::Publishing
+
+Adds some helper UI for publishing in Outpost. Also adds the ability to use
+auto-publishing for any content.
+
+This gem assumes that the models you want to use it with have at least a 
+"Published" and "Pending" status, and that they respond to `#published?` and 
+`#pending?`.
+
+
+## Installation
+
+    gem 'outpost-publishing'
+
+## Usage
+
+Drop it into your javascript manifest:
+
+```javascript
+//= require outpost/publishing
+//= require outpost/content_alarms
+```
+
+Then instantiate using Javascript. Initialize by passing in a few options:
+
+* the form selector (such as `#post_99`),
+* the selector of the div wrapper around the publishing fields,
+* the selector for where to render the notifications,
+* the selector for the status input
+* (optional) `statusPending` and `statusPublished` to indicate the value
+for each of those. Default is 3 and 5, respectively.
+
+```javascript
+$(function() {
+  publishing = new outpost.Publishing({
+    form: "#<%=f.options[:html][:id]%>",
+    container: ".publishing-fields",
+    notifications: "<%= options[:notifications] || "#scheduled_status" %>",
+    statusField: "#status-select"
+  });
+});
+```
+
+
+### Content Alarms
+
+This gem only provides UI for content alarms. You'll need to do the
+server-side stuff yourself.
+
+An alarm might look like this:
+
+```ruby
+create_table :publish_alarms do |t|
+  t.integer :content_id
+  t.string :content_type
+  t.datetime :fire_at
+  t.timestamps
+end
+
+add_index :publish_alarms, [:content_type, :content_id]
+add_index :publish_alarms, :fire_at
+```
+
+The only things that the UI script requires is a "fire_at" field, and a status
+field to read.
+
+
+## Contributing
+
+Yes, please. PR's are appreciated.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/assets/javascripts/outpost/content_alarm.js.coffee

@@ -0,0 +1,62 @@
+#= require outpost/publishing_helper
+
+##
+# ContentAlarm
+#
+# Show/hide ContentAlarm fields based on status.
+# Also renders messages based on status & timestamp
+#
+class outpost.ContentAlarm extends outpost.PublishingHelper
+    constructor: (@options={}) ->
+        super
+        
+        # The actual datetime input 
+        @datetimeField = @container.find("input.datetime")
+        
+        # Alerts
+        @alerts =
+            isScheduled:    new outpost.Notification(@notifications, "success", "This content is <strong>scheduled</strong> to be published.")
+            isNotScheduled: new outpost.Notification(@notifications, "info", "This content is <strong>not scheduled</strong> to be published.")
+
+        # Notify the scheduled status
+        @originalStatus = @setStatus() # also sets @status
+        @hideFields() # Hidden by default.
+        @setTimestamp()
+        @notify()
+        
+        # Event for when the timestamp field is changed
+        @datetimeField.on
+            update: (event) => 
+                @setTimestamp()
+                @notify()
+
+    #----------
+    # Set @timestamp to the current value of the timestamp field
+    setTimestamp: ->
+        @timestamp = @datetimeField.val()
+
+    #----------
+
+    notify: ->
+        @clearAlerts()
+        
+        timestampFilled = !_.isEmpty(@timestamp)
+        isPending       = @isPending()
+        isPublished     = @isPublished()
+        
+        # Show the fields if it's pending.
+        if isPending then @showFields() else @hideFields()
+        
+        # When it IS scheduled
+        if isPending and timestampFilled
+            return @alert 'isScheduled'
+        
+        # When it ISN'T scheduled
+        if isPending and !timestampFilled
+            return @alert 'isNotScheduled'
+        
+        # This one assumes that the PublishingUI script
+        # will let the user know about Publishing Immediately.
+        if !isPending and !isPublished and timestampFilled
+            @hideFields()
+            return @alert 'isNotScheduled'

data/lib/assets/javascripts/outpost/publishing.js.coffee

@@ -0,0 +1,50 @@
+#= require outpost/publishing_helper
+
+##
+# PublishingUI
+#
+# Show/hide Publishing fields based on status.
+# Also renders messages based on status
+#
+class outpost.Publishing extends outpost.PublishingHelper
+    constructor: (@options={}) ->
+        super
+        
+        # Alerts
+        @alerts =
+            willPublish:    new outpost.Notification(@notifications, "warning", "This content <strong>will be published</strong> immediately.")
+            isPublished:    new outpost.Notification(@notifications, "success", "This content is <strong>published</strong>")
+            willUnpublish:  new outpost.Notification(@notifications, "danger", "<strong>Warning!</strong> This content <strong>will be unpublished</strong> immediately.")
+            
+        # Notify the scheduled status
+        @originalStatus = @setStatus() # also sets @status
+        @hideFields() # Hidden by default.
+        @notify()
+
+    #----------
+
+    notify: ->
+        @clearAlerts()
+        
+        # No need to run these methods more than once
+        isPublished = @isPublished()
+        wasPublished = @wasPublished()
+        
+        # Show the fields if it's published.
+        @showFields() if isPublished
+        
+        # All the different scenarios
+        # Already published
+        if isPublished and wasPublished
+            @showFields()
+            return @alert 'isPublished'
+            
+        # Publishing
+        if isPublished and !wasPublished
+            @hideFields()
+            return @alert 'willPublish'
+        
+        # Unpublishing
+        if !isPublished and wasPublished
+            @hideFields()
+            return @alert 'willUnpublish'

data/lib/assets/javascripts/outpost/publishing_helper.js.coffee

@@ -0,0 +1,71 @@
+##
+# PublishingHelper
+#
+# Some shared code for rendering alerts, and toggling fields
+#
+class outpost.PublishingHelper
+    defaults:
+        statusPending:    "3"
+        statusPublished:  "5"
+    
+    constructor: (@options={}) ->
+        _.defaults @options, @defaults
+
+        @statusPending   = @options.statusPending
+        @statusPublished = @options.statusPublished
+
+        # Elements
+        @form          = $ @options.form
+        @container     = $ @options.container,     @form # Wrapper for the fields
+        @statusField   = $ @options.statusField,   @form # Status select
+        @notifications = $ @options.notifications, @form # Notification bucket
+
+        # Event for when the status field is changed
+        @statusField.on
+            change: (event) =>
+                @setStatus()
+                @notify()
+        
+    #----------
+    # Get the current status from the dropdown
+    setStatus: ->
+        @status = $("option:selected", @statusField).val()
+    
+    #----------
+    # Helpers for finding current and original status
+    isPending: ->
+        @status is @statusPending
+        
+    isPublished: ->
+        @status is @statusPublished
+        
+    wasPending: ->
+        @originalStatus is @statusPending
+        
+    wasPublished: ->
+        @originalStatus is @statusPublished
+        
+    #----------
+    # Handles scenarios
+    notify: ->
+        # Override me
+
+    #----------
+    # Render the notification
+    alert: (key) ->
+        @alerts[key].render()
+        
+    #----------
+    # Mass-Detach all of the alerts
+    clearAlerts: ->
+        alert.detach() for name,alert of @alerts
+
+    #----------
+    
+    showFields: ->
+        @container.show()
+
+    #----------
+
+    hideFields: ->
+        @container.hide()

data/lib/outpost/publishing.rb

@@ -0,0 +1,9 @@
+require "outpost/publishing/version"
+
+module Outpost
+  module Publishing
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+

data/lib/outpost/publishing/version.rb

@@ -0,0 +1,5 @@
+module Outpost
+  module Publishing
+    VERSION = "1.0.0"
+  end
+end

data/outpost-publishing.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outpost/publishing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "outpost-publishing"
+  spec.version       = Outpost::Publishing::VERSION
+  spec.authors       = ["Bryan Ricker"]
+  spec.email         = ["bricker88@gmail.com"]
+  spec.description   = %q{Enhanced content publishing for Outpost.}
+  spec.summary       = %q{Outpost plugin for publishing helper UI.}
+  spec.homepage      = "https://github.com/SCPR/outpost-publishing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: outpost-publishing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Bryan Ricker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enhanced content publishing for Outpost.
+email:
+- bricker88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/assets/javascripts/outpost/content_alarm.js.coffee
+- lib/assets/javascripts/outpost/publishing.js.coffee
+- lib/assets/javascripts/outpost/publishing_helper.js.coffee
+- lib/outpost/publishing.rb
+- lib/outpost/publishing/version.rb
+- outpost-publishing.gemspec
+homepage: https://github.com/SCPR/outpost-publishing
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Outpost plugin for publishing helper UI.
+test_files: []
+has_rdoc: