feeder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfe0a59dcdce80dc8bf2fedfa9ad04cf8e920b24
-  data.tar.gz: 6c99238d2c20c2144abb57f2d68324c7ef01754d
+  metadata.gz: 71863a0628990d62aeddb4f61c4f76de58cde827
+  data.tar.gz: b5d6ac0fad7490de8280736f8f2dbc3cb6f46a5b
 SHA512:
-  metadata.gz: 6353552cce887eaf65a51919ecd542a96e62258482e081965a4ca407925b991e352626649baa6ca814a14c47f7555885ba60c69e8f2e68146b05d30c8f0ec60f
-  data.tar.gz: c76593f7f6c1c01c1f8bfe944bdc2effb9bbefe5ff95124e95c01081854b15e311d996cf9c6c251ed90081ebc1645d1dceb354e37a2b06f20c8f11e0b1553ee4
+  metadata.gz: 2584423be6b0d9edf1e929b8c0e92b55b9a1ff46129568e7208997b306ccdf6a1a07d5c5d6dd81813183e1dd7626c03794a2fc564334f781c76dc138560db494
+  data.tar.gz: 67bfa31393a735effcda82048bbfec9106467b8f63680d3966d263bc8845bea019928d022f54beb4e00c5228e78e9e008d4532a7b6c56288228b762ae5054dec

data/README.md

@@ -0,0 +1,44 @@
+# Mingle
+
+Feeder gives you a mountable engine that provides a route to a feed page in your
+Ruby on Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'feeder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install feeder
+
+Install the migrations:
+
+    rake feeder:install:migrations
+    
+Run the migrations:
+
+    rake db:migrate
+
+## 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
+
+## Credits
+
+Hyper made this. We're a digital communications agency with a passion for good code,
+and if you're using this library we probably want to hire you.
+
+
+## License
+
+Feeder is available under the MIT license. See the MIT-LICENSE file for more info.

data/app/controllers/feeder/feeds_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "feeder/application_controller"
+
+module Feeder
+  class FeedsController < ApplicationController
+    def index
+      @items = Item.order published_at: :desc
+    end
+  end
+end

data/app/helpers/feeder/feeds_helper.rb

@@ -0,0 +1,4 @@
+module Feeder
+  module FeedsHelper
+  end
+end

data/app/models/feeder/feedable_observer.rb

@@ -0,0 +1,13 @@
+module Feeder
+  class FeedableObserver < ActiveRecord::Observer
+    observe Feeder.config.observables
+
+    def after_create(feedable)
+      Feeder::Item.create!(
+        feedable: feedable,
+        created_at: feedable.created_at,
+        published_at: Time.zone.now
+      )
+    end
+  end
+end

data/app/models/feeder/item.rb

@@ -0,0 +1,9 @@
+module Feeder
+  class Item < ActiveRecord::Base
+    belongs_to :feedable, polymorphic: true
+
+    def type
+      feedable_type.underscore
+    end
+  end
+end

data/app/views/feeder/feeds/index.html.erb

@@ -0,0 +1,3 @@
+<div class="feed_items">
+  <%= render @items %>
+</div>

data/app/views/feeder/items/_item.html.erb

@@ -0,0 +1,3 @@
+<div class="feed_item <%= item.type %>">
+  <%= render "feeder/types/#{item.type}", feedable: item.feedable %>
+</div>

data/config/routes.rb

@@ -1,2 +1,3 @@
 Feeder::Engine.routes.draw do
+  root to: 'feeds#index', via: :get
 end

data/db/migrate/20140317150822_create_feeder_items.rb

@@ -0,0 +1,9 @@
+class CreateFeederItems < ActiveRecord::Migration
+  def change
+    create_table :feeder_items do |t|
+      t.datetime :published_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140317152137_add_polymorphic_feedable_reference_to_feeder_items.rb

@@ -0,0 +1,5 @@
+class AddPolymorphicFeedableReferenceToFeederItems < ActiveRecord::Migration
+  def change
+    add_reference :feeder_items, :feedable, polymorphic: true, index: true
+  end
+end

data/lib/feeder.rb

@@ -1,4 +1,18 @@
 require "feeder/engine"
+require "feeder/configuration"
 
 module Feeder
+
+  class << self
+    def config
+      @configuration ||= Feeder::Configuration.new
+    end
+
+    def configure
+      raise ArgumentError, "No block provided" unless block_given?
+
+      yield config
+    end
+  end
+
 end

data/lib/feeder/configuration.rb

@@ -0,0 +1,13 @@
+module Feeder
+  class Configuration
+    attr_reader :observables
+
+    def initialize
+      @observables = []
+    end
+
+    def add_observable(observable)
+      @observables << observable
+    end
+  end
+end

data/lib/feeder/engine.rb

@@ -1,5 +1,10 @@
+require 'rails-observers'
+
 module Feeder
   class Engine < ::Rails::Engine
     isolate_namespace Feeder
+
+    config.active_record.observers ||= []
+    config.active_record.observers << 'Feeder::FeedableObserver'
   end
 end

data/lib/feeder/version.rb

@@ -1,3 +1,3 @@
 module Feeder
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/controllers/feeder/feeds_controller_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Feeder
+  describe FeedsController do
+    routes { Feeder::Engine.routes }
+
+    describe "GET 'index'" do
+      let!(:items) do
+        10.times.map do
+          m = Message.create header: 'Header', body: 'Body'
+          Item.create feedable: m, published_at: Time.zone.now
+        end.sort_by(&:published_at).reverse
+      end
+
+      it "returns http success" do
+        get :index
+        expect(response).to be_successful
+      end
+
+      it "fetches feed items ordered by publiction date, descending" do
+        get :index
+        expect(assigns(:items)).to eq items
+      end
+    end
+
+  end
+end

data/spec/dummy/README.md

@@ -0,0 +1,20 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+* System dependencies
+* Configuration
+* Database creation
+* Database initialization
+* How to run the test suite
+* Services (job queues, cache servers, search engines, etc.)
+* Deployment instructions
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+`rake doc:app`.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/message.rb

@@ -0,0 +1,3 @@
+class Message < ActiveRecord::Base
+  has_one :feeder_item, as: :feedable, class_name: 'Feeder::Item'
+end

data/spec/dummy/app/views/feeder/types/_message.html.erb

@@ -0,0 +1,7 @@
+<h1 class="header">
+  <%= feedable.header %>
+</h1>
+
+<div class="body">
+  <%= simple_format feedable.body %>
+</div>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "feeder"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+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/spec/dummy/config/database.yml

@@ -0,0 +1,30 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+# Do not keep production credentials in the repository,
+# instead read the configuration from the environment.
+#
+# Example:
+#   sqlite3://myuser:mypass@localhost/full/path/to/somedatabase
+#
+production:
+  url: <%= ENV["DATABASE_URL"] %>

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end