outpost-secretary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6e4760ffad7d6da2adda0ae3e7e01f383bfb948
+  data.tar.gz: 4bae09801eab3779b487f5f3e85f9959cff5bed2
+SHA512:
+  metadata.gz: 33b9ed5eb3bba9d81a397791c6162dca928bff178bec8660bf697cba9bc0efb2ab0ca970ac11b3a2afa0134102736a9d84b314b64f640b1022987830f14ac2a9
+  data.tar.gz: 35080cee2fbe7f9102c3aa0f174b2b567f7899d8c19bb575fda032fe3f1230e7668606a4af2bf9efe1870dd6a95a0e4e8c1ea2ff1acdb2d6199533c0eeb90146

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/CHANGELOG.md

@@ -0,0 +1,2 @@
+### 0.1.0
+* Initial Release

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'outpost-cms', github: "SCPR/outpost"
+  gem 'secretary-rails'
+  gem 'kaminari'
+  gem 'activerecord'
+  gem 'actionpack'
+  gem "sqlite3", "~> 1.3"
+  gem 'combustion', github: "pat/combustion"
+  gem "rspec-rails", "~> 2.13.1"
+  gem "factory_girl", "~> 4.2"
+end
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Southern California Public Radio
+
+MIT License
+
+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,52 @@
+# Outpost/Secretary
+
+[secretary-rails](http://rubygems.org/gems/secretary-rails) integration with Outpost.
+Provides views and controller for Outpost.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'outpost-secretary'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install outpost-secretary
+
+## Usage
+
+If you already have secretary-rails installed and configured, then all you need to do is add this to your routes about the "outpost" namespace (the "secretary" name is hardcoded and not optional):
+
+```ruby
+# ...
+mount Outpost::Secretary::Engine, at: "outpost", as: "secretary"
+
+namespace :outpost do
+  #...
+end
+```
+
+And add the stylesheet to your outpost/application.css:
+
+```scss
+@import 'outpost/secretary';
+```
+
+Finally, be sure to add `logged_user_id` to your Strong Parameters where necessary.
+
+If Secretary isn't yet installed, check out the [secretary-rails documentation](https://github.com/SCPR/secretary-rails) for instructions.
+
+## Todo
+* Needs more tests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+RAKED = true
+
+require 'bundler/setup'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'combustion'
+
+Bundler.require :default, :test
+Combustion.initialize! :active_record, :action_controller, :action_view
+Combustion::Application.load_tasks
+
+RSpec::Core::RakeTask.new(:test)
+task default: :test

data/app/assets/stylesheets/outpost/secretary.css.scss

@@ -0,0 +1,2 @@
+@import 'secretary/columns';
+@import 'secretary/diff';

data/app/assets/stylesheets/outpost/secretary/columns.css.scss

@@ -0,0 +1,17 @@
+table {
+    ///////////////////
+    // Secretary::Version
+    &.list-secretary_versions {
+        .column-user {
+            width: 150px;
+        }
+
+        .column-description {
+            width: 350px;
+        }
+
+        .column-versioned {
+            width: 200px;
+        }
+    }
+}

data/app/assets/stylesheets/outpost/secretary/diff.css.scss

@@ -0,0 +1,61 @@
+.diff {
+    overflow:auto;
+
+    ul {
+        background:#fff;
+        overflow:auto;
+        font-size:13px;
+        list-style:none;
+        margin:0;
+        padding:0;
+        display:table;
+        width:100%;
+    }
+    del, ins {
+        display:block;
+        text-decoration:none;
+    }
+
+    li {
+        padding:0;
+        display:table-row;
+        margin: 0;
+        height:1em;
+
+        &.ins {
+            background:#dfd; color:#080
+        }
+
+        &.del {
+            background:#fee;
+            color:#b00
+        }
+
+        &:hover {
+            background:#ffc
+        }
+
+        &.diff-comment {
+            display: none;
+        }
+
+        &.diff-block-info {
+            background: none repeat scroll 0 0 gray;
+        }
+    }
+
+    .del, .ins, span {
+        white-space:pre-wrap;
+        font-family:courier;
+    }
+
+    .del strong {
+        font-weight:normal;
+        background:#fcc;
+    }
+
+    .ins strong {
+        font-weight:normal;
+        background:#9f9;
+    }
+}

data/app/controllers/concerns/outpost/secretary/user_injection.rb

@@ -0,0 +1,19 @@
+module Outpost
+  module Secretary
+    module UserInjection
+      extend ActiveSupport::Concern
+
+      included do
+        before_filter :add_user_id_to_params, only: [:create, :update]
+      end
+
+      private
+
+      def add_user_id_to_params
+        if model.has_secretary?
+          params[model.singular_route_key].merge!(logged_user_id: current_user.id)
+        end
+      end
+    end
+  end
+end

data/app/controllers/outpost/versions_controller.rb

@@ -0,0 +1,94 @@
+class Outpost::VersionsController < Outpost::BaseController
+  include Outpost::Controller::Ordering
+
+  self.model = Secretary::Version
+
+  define_list do |l|
+    l.default_order_attribute   = "created_at"
+    l.default_order_direction   = Outpost::DESCENDING
+    l.per_page                  = 10
+
+    l.column :user, display: ->(r) { r.user.try(:to_title) || "System" }
+    l.column :description
+    l.column :versioned,
+      :header     => "Object",
+      :display    => ->(r) { r.versioned.simple_title }
+
+    l.column :version_number, header: "Version"
+    l.column :created_at, header: "Timestamp"
+  end
+
+
+  before_filter :set_order_and_direction, only: [:index, :show, :activity]
+  before_filter :get_object, only: [:index, :show]
+  before_filter :authorize_resource, only: [:index, :show]
+  before_filter :extend_breadcrumbs_for_object, only: [:index, :show]
+
+
+  #--------------
+  # See all activity
+  def activity
+    breadcrumb "Activity"
+
+    @versions = Secretary::Version.order(order)
+      .page(params[:page]).per(list.per_page)
+
+    render :index
+  end
+
+
+  #--------------
+  # See activity for a single object
+  def index
+    breadcrumb "History"
+
+    @versions = @object.versions.order(order)
+      .page(params[:page]).per(list.per_page)
+  end
+
+
+  #--------------
+  # Compare a version to its previous version
+  def show
+    @version = @object.versions.find_by_version_number!(params[:version_number])
+
+    breadcrumb "History",
+      secretary.history_path(@object.class.route_key, @object.id),
+      @version.to_title
+  end
+
+
+  private
+
+  # Override this from Outpost to get around kaminari bug:
+  # https://github.com/amatsuda/kaminari/issues/457
+  def route_proxy
+    secretary
+  end
+
+
+  def set_order_and_direction
+    @order_attribute  = "created_at"
+    @order_direction  = Outpost::DESCENDING
+  end
+
+
+  def get_object
+    klass = Outpost::Helpers::Naming.to_class(params[:resources])
+    redirect_to outpost.root_path if !klass.has_secretary?
+    @object = klass.find(params[:resource_id])
+  end
+
+
+  def authorize_resource
+    authorize(@object.class)
+  end
+
+
+  def extend_breadcrumbs_for_object
+    breadcrumb @object.class.name.titleize.pluralize,
+      @object.class.admin_index_path
+
+    breadcrumb @object.simple_title, @object.admin_edit_path
+  end
+end

data/app/views/outpost/versions/_header.html.erb

@@ -0,0 +1 @@
+<%= link_to("Edit this #{object.class.name.titleize}", object.admin_edit_path, class: "btn btn-primary pull-right") if object.present? %>

data/app/views/outpost/versions/index.html.erb

@@ -0,0 +1,28 @@
+<% if @object %>
+  <%= render 'header', page_title: content_for(:page_title), object: @object %>
+  <% add_to_page_title @object.simple_title %>
+<% end %>
+
+<% add_to_page_title "History" %>
+
+<%= list_table @versions, model do %>
+  <thead>
+    <tr>
+      <%= render "outpost/shared/headers", list: list %>
+    </tr>
+  </thead>
+  <tbody class="list">
+    <% @versions.each do |version| %>
+      <% record = version.versioned %>
+      <tr class="versions">
+        <td class="column-manage">
+          <%= guard record.class do %>
+            <%= link_to "View", secretary.version_path(resources: record.class.route_key, resource_id: record.id, version_number: version.version_number), class: "btn" %>
+          <% end %>
+        </td>
+
+        <%= render "outpost/shared/columns", list: list, record: version %>
+      </tr>
+    <% end %>
+  </tbody>
+<% end %>

data/app/views/outpost/versions/show.html.erb

@@ -0,0 +1,11 @@
+<% add_to_page_title @version.to_title, "History" %>
+
+<%= render 'header', page_title: content_for(:page_title), object: @object %>
+
+<% @version.attribute_diffs.each do |attribute, diff| %>
+  <h4><%= attribute.titleize %></h4>
+  <div class="well">
+    <%= diff.to_s(:html).html_safe %>
+  </div>
+  <hr />
+<% end %>

data/circle.yml

@@ -0,0 +1,7 @@
+ruby:
+  version:
+    '2.1.1'
+
+database:
+  override:
+    - echo 'skipping'

data/config/routes.rb

@@ -0,0 +1,5 @@
+Outpost::Secretary::Engine.routes.draw do
+  get "/activity" => "outpost/versions#activity", as: :activity
+  get "/:resources/:resource_id/history" => "outpost/versions#index", as: :history
+  get "/:resources/:resource_id/history/:version_number" => "outpost/versions#show", as: :version
+end

data/lib/outpost/secretary.rb

@@ -0,0 +1,7 @@
+require "outpost/secretary/version"
+require "outpost/secretary/engine"
+
+module Outpost
+  module Secretary
+  end
+end

data/lib/outpost/secretary/engine.rb

@@ -0,0 +1,22 @@
+module Outpost
+  module Secretary
+    class Engine < ::Rails::Engine
+      # This is necessary to support rails 3, which doesn't autoload
+      # the concerns directory
+      config.autoload_paths << File.expand_path(
+        "../../../../app/controllers/concerns", __FILE__)
+
+      config.to_prepare do
+        # Make versions an outpost model so it can be represented in Outpost.
+        ::Secretary::Version.instance_eval do
+          outpost_model
+        end
+
+        # Add user injection callback to resource controller.
+        Outpost::ResourceController.instance_eval do
+          include Outpost::Secretary::UserInjection
+        end
+      end
+    end
+  end
+end

data/lib/outpost/secretary/version.rb

@@ -0,0 +1,5 @@
+module Outpost
+  module Secretary
+    VERSION = "0.1.0"
+  end
+end

data/outpost-secretary.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/secretary/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "outpost-secretary"
+  spec.version       = Outpost::Secretary::VERSION
+  spec.authors       = ["Bryan Ricker"]
+  spec.email         = ["bricker88@gmail.com"]
+  spec.description   = "secretary-rails integration with Outpost."
+  spec.summary       = "Provides views and controllers for" \
+                       "secretary-rails integration with Outpost."
+  spec.homepage      = "https://github.com/SCPR/outpost-secretary"
+  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_dependency "outpost-cms", ['>= 0.0.1', "< 1"]
+  spec.add_dependency "secretary-rails", ['>= 1.0.0', "< 2"]
+end

data/spec/controllers/versions_controller_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Outpost::VersionsController do
+  routes { Outpost::Secretary::Engine.routes }
+  render_views
+
+  before :each do
+    @user = create :user
+    controller.stub(:current_user) { @user }
+  end
+
+  describe "GET /activity" do
+    it "lists all recent activity" do
+      post1 = create :post
+      post2 = create :post
+      post3 = create :post
+
+      get :activity
+      versions = assigns(:versions)
+
+      versions.should include post3.versions.first
+      versions.should include post2.versions.first
+      versions.should include post1.versions.first
+    end
+  end
+
+
+  describe "GET /index" do
+    it "lists activity for a record" do
+      post1 = create :post
+      post2 = create :post
+
+      get :index, resources: "posts", resource_id: post1.id
+      assigns(:versions).should eq post1.versions.to_a
+    end
+  end
+
+  describe "GET /show" do
+    it "gets the requested version" do
+      post = create :post
+
+      get :show, {
+        :resources        => "posts",
+        :resource_id      => post.id,
+        :version_number   => 1
+      }
+
+      assigns(:version).should eq post.versions.first
+    end
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,14 @@
+FactoryGirl.define do
+  factory :user do
+    name "Bryan"
+    sequence(:username) { |n| "bricker-#{n}" }
+    sequence(:email) { |n| "bricker-#{n}@scpr.org" }
+    password "secret"
+    password_confirmation { password }
+  end
+
+  factory :post do
+    headline "Post"
+    body "Post Body"
+  end
+end

data/spec/internal/app/controllers/outpost/posts_controller.rb

@@ -0,0 +1,6 @@
+class Outpost::PostsController < Outpost::ResourceController
+  define_list do |l|
+    l.column :headline
+    l.column :body
+  end
+end

data/spec/internal/app/models/post.rb

@@ -0,0 +1,4 @@
+class Post < ActiveRecord::Base
+  outpost_model
+  has_secretary
+end

data/spec/internal/app/models/user.rb

@@ -0,0 +1,12 @@
+class User < ActiveRecord::Base
+  include Outpost::Model::Authentication
+
+  # TODO These methods are hacks because outpost has authorization hardcoded in.
+  def can_manage?(*)
+    true
+  end
+
+  def allowed_resources
+    Outpost.config.registered_models
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  mount Outpost::Engine, at: 'outpost'
+  mount Outpost::Secretary::Engine, at: 'outpost', as: 'secretary'
+
+  namespace :outpost do
+    resources :posts
+  end
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :username
+    t.string :email
+    t.string :password_digest
+    t.boolean :is_superuser
+    t.datetime :last_login
+    t.timestamps
+  end
+
+  create_table :posts, force: true do |t|
+    t.string :headline
+    t.text :body
+    t.timestamps
+  end
+
+  create_table :versions, force: true do |t|
+    t.integer  :version_number
+    t.string   :versioned_type
+    t.integer  :versioned_id
+    t.integer  :user_id
+    t.text     :description
+    t.text     :object_changes
+    t.datetime :created_at
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'combustion'
+
+unless defined?(RAKED)
+  Bundler.require :default, :test
+  Combustion.initialize! :active_record, :action_controller, :action_view
+end
+
+require 'rspec/rails'
+require 'factory_girl'
+load 'factories.rb'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+
+Dir[File.expand_path("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.mock_with :rspec
+  config.order = "random"
+  config.infer_base_class_for_anonymous_controllers = false
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: outpost-secretary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Ricker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: outpost-cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: secretary-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: secretary-rails integration with Outpost.
+email:
+- bricker88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/outpost/secretary.css.scss
+- app/assets/stylesheets/outpost/secretary/columns.css.scss
+- app/assets/stylesheets/outpost/secretary/diff.css.scss
+- app/controllers/concerns/outpost/secretary/user_injection.rb
+- app/controllers/outpost/versions_controller.rb
+- app/views/outpost/versions/_header.html.erb
+- app/views/outpost/versions/index.html.erb
+- app/views/outpost/versions/show.html.erb
+- circle.yml
+- config/routes.rb
+- lib/outpost/secretary.rb
+- lib/outpost/secretary/engine.rb
+- lib/outpost/secretary/version.rb
+- outpost-secretary.gemspec
+- spec/controllers/user_injection_spec.rb
+- spec/controllers/versions_controller_spec.rb
+- spec/factories.rb
+- spec/internal/app/controllers/outpost/posts_controller.rb
+- spec/internal/app/models/post.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb
+homepage: https://github.com/SCPR/outpost-secretary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides views and controllers forsecretary-rails integration with Outpost.
+test_files:
+- spec/controllers/user_injection_spec.rb
+- spec/controllers/versions_controller_spec.rb
+- spec/factories.rb
+- spec/internal/app/controllers/outpost/posts_controller.rb
+- spec/internal/app/models/post.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb