segments 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+group :development do
+    gem 'jeweler'
+    gem 'git'
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git
+  jeweler

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Josh McArthur
+
+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,53 @@
+Segments
+========
+
+A Rails 3 Engine for managing and rendering text segments into your Rails web application. Segments are short-to-medium blocks of text or HTML that you wish to use throughout your application. It includes a web interface for managing segments, and is automatically compatible with Internationalization (I18n).
+
+Features
+--------
+
+* Rails 3 Engine
+* Internationalized web interface
+* Customizable
+* Supports segments in multiple languages
+* ActiveRecord backend
+
+Installation
+------------
+
+1. Add Segments to your Gemfile
+    `gem 'segments'` (Stable)
+    `gem 'segments', :git => 'https://github.com/joshmcarthur/segments.git`
+2. Install the engine
+    `bundle install`
+    `rails generate segments`
+3. Migrate database
+    `rake db:migrate`
+
+Usage
+-----
+
+* Managing segments:
+    * Start your application, and visit /segments to manage segments
+    * A segment has a key (Like an Internationalization key, except a string), content and a locale for which it should be rendered (I18n's default locale is the default). Keys can be the same, as long as the locale is different. This effectively means that you can have the same segment, for different languages.
+    * If you require this segment page to be secured, you can override the authenticate_segments method of the SegmentsController to authenticate users.
+* Displaying segments:
+    * A helper method called render_segment is available to all views. This block accpets a single argument, which is the key of the segment to render. The code that finds the segment uses I18n's current locale, so as long as this is set correctly, the correct segment will be rendered. 
+ 
+Contributing
+------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 Josh McArthur. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "segments"
+  gem.homepage = "http://github.com/joshmcarthur/segments"
+  gem.version = File.exists?('VERSION') ? File.read('VERSION') : ''
+  gem.license = "MIT"
+  gem.summary = %Q{A Rails 3 Engine for managing text segments}
+  gem.description = %Q{A Rails 3 Engine for managing and rendering text segments into your Rails web application. Segments are short-to-medium blocks of text or HTML that you wish to use throughout your application. It includes a web interface for managing segments, and is automatically compatible with Internationalization (I18n)}
+  gem.email = "joshua.mcarthur@gmail.com"
+  gem.authors = ["Josh McArthur"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/segments_controller.rb

@@ -0,0 +1,40 @@
+class SegmentsController < ApplicationController
+  respond_to(:html, :json, :xml)
+  
+  layout 'layouts/segment_layout'
+  
+  #Override authenticate_for_segments to handle authentication
+  before_filter :authenticate_for_segments
+  before_filter :load_segment, :except => [:index, :new, :create]
+  
+  def index
+    respond_with @segments = Segment.all
+  end
+  
+  def update
+    respond_with @segment.update_attributes(params[:segment]), :location => segments_path
+  end
+  
+  def create
+    respond_with @segment = Segment.create(params[:segment]), :location => segments_path
+  end
+  
+  def destroy
+    respond_with @segment.destroy
+  end
+  
+  def show
+    respond_with @segment
+  end
+  
+  
+  private
+  
+  def authenticate_for_segments
+    return true
+  end
+  
+  def load_segment
+    @segment = Segment.find(params[:id])
+  end
+end

data/app/models/segment.rb

@@ -0,0 +1,14 @@
+class Segment < ActiveRecord::Base
+
+  validates_uniqueness_of :key, :scope => :locale
+  validates_presence_of :content, :locale
+  before_validation :set_default_locale
+  
+  private
+  
+  def set_default_locale
+    return unless self.locale.nil? || self.locale.blank?
+    self.locale = I18n.default_locale
+  end
+  
+end

data/app/views/layouts/segment_layout.html.erb

@@ -0,0 +1,27 @@
+<html>
+  <head>
+    <title><%= t('segments.title') %></title>
+    <style type="text/css">
+      body { background: #556270; font-size: 16px; font-family: sans-serif;}
+      div.container { margin: 20px auto; padding: 20px; border: solid 1px #666; width: 700px; min-height: 500px; background-color: #FCFBE3; }
+      label { color: #333; font-size: 80%; font-style: italic; padding: 2px 0; }
+      fieldset { border: solid 1px #999; }
+      legend { font-weight: bold; }
+      form.button_to, form.button_to div { display: inline; }
+      a, form.button_to input { margin: 0; padding: 5px; color: #333; text-decoration: none; font-size: 90%; background: none; border: 0; }
+      table { width: 100%; border-collapse: collapse; }
+      th { text-align: left; }
+      td.locale { width: 20%; }
+      td.key { width: 50%; }
+      td { width: 5%; }
+      tr.segment:hover { background-color: #CCC;}
+      a:hover, form.button_to input:hover { background-color: #556270; color: #FFF; }
+    </style>
+  </head>
+  
+  <body>
+    <div class="container">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/app/views/segments/_form.html.erb

@@ -0,0 +1,19 @@
+
+    <p>
+      <%= form.label :locale -%><br />
+      <%= form.select :locale, I18n.available_locales -%>
+    </p>
+   
+    <p>
+      <%= form.label :key -%><br />
+      <%= form.text_field :key -%>
+    </p>
+    
+    <p>
+      <%= form.label :content -%><br />
+      <%= form.text_area :content, :rows => 5 -%>
+    </p>
+    
+    <p>
+      <%= form.submit %>
+    </p>

data/app/views/segments/_segment_row.html.erb

@@ -0,0 +1,7 @@
+<tr class="segment">
+  <td class="locale"><%= segment.locale -%></td>
+  <td class="key"><%= segment.key -%></td>
+  <td><%= link_to t('segments.show_link'), segment_url(segment) -%></td>
+  <td><%= link_to t('segments.edit_link'), edit_segment_url(segment) -%></td>
+  <td><%= button_to t('segments.destroy_link'), segment_url(segment), :method => :delete -%></td>
+</tr>

data/app/views/segments/edit.html.erb

@@ -0,0 +1,4 @@
+<%= content_tag :h1, t('segments.edit.heading', :key => @segment.key, :language => @segment.locale) -%>
+<%= form_for @segment do |form| %>
+  <%= render :partial => 'form', :locals => {:form => form} -%>
+<% end -%>

data/app/views/segments/index.html.erb

@@ -0,0 +1,22 @@
+<%= content_tag :h1, t('segments.index.heading') -%>
+<%= form_for Segment.new do |form| %>
+  <fieldset>
+    <legend><%= t('segments.new.form.legend') -%></legend>
+    <%= render :partial => 'form', :locals => {:form => form} -%>
+  </fieldset>
+<% end -%>
+
+<table>
+  <thead>
+    <tr>
+      <th>Locale</th>
+      <th>Key</th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+ 
+  <tbody>
+    <%= render :partial => 'segment_row', :collection => @segments, :as => :segment -%>
+  </tbody
+</table>

data/app/views/segments/show.html.erb

@@ -0,0 +1,6 @@
+<%= content_tag :h1, t('segments.show.heading', {:language => @segment.locale , :key => @segment.key}) -%>
+
+<%= content_tag :div, @segment.content %>
+
+<%= link_to t('segments.back_link'), segments_url -%>
+<%= link_to t('segments.edit_link'), edit_segment_url(@segment) -%>

data/config/boot.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+    segments:
+        title: Manage Segments
+        index: 
+            heading: Segments
+        show_link: View
+        edit_link: Edit
+        destroy_link: Delete
+        back_link: Back
+        edit:
+            heading: Editing segment %{key} (%{language})
+        show:
+            heading: %{key} (%{language})
+        new:   
+            form:
+                legend: New Segment
+            

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  # Add your engine routes here
+  resources :segments
+end

data/lib/engine.rb

@@ -0,0 +1,24 @@
+module Segments
+  class Engine < Rails::Engine
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+      
+      ActionView::Rendering.module_eval do
+        def render_segment(segment_name = "")
+          segment = Segment.find_by_key_and_locale(
+            segment_name, 
+            I18n.locale
+          )
+          render :text => segment.content.html_safe if segment
+        end
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc 
+  end
+end
+

data/lib/generators/segments/segments_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class SegmentsGenerator < Rails::Generators::Base
+  
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def create_migration_file
+     migration_template 'segments_migration.rb', 'db/migrate/create_segments.rb'
+  end  
+end

data/lib/generators/segments/templates/segments_migration.rb

@@ -0,0 +1,17 @@
+class CreateSegments < ActiveRecord::Migration
+  def self.up
+    create_table :segments do |t|
+      t.string :key, :null => false
+      t.string :locale, :null => false
+      t.text   :content
+    end
+    
+    add_index :segments, :key, :unique => true
+  end
+  
+  def self.down
+    drop_index :segments, :key
+    drop_table :segments
+  end
+  
+end

data/lib/segments.rb

@@ -0,0 +1,3 @@
+module Segments
+  require 'engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/tasks/segments.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

data/segments.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{segments}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh McArthur"]
+  s.date = %q{2011-06-04}
+  s.description = %q{A Rails 3 Engine for managing and rendering text segments into your Rails web application. Segments are short-to-medium blocks of text or HTML that you wish to use throughout your application. It includes a web interface for managing segments, and is automatically compatible with Internationalization (I18n)}
+  s.email = %q{joshua.mcarthur@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/segments_controller.rb",
+    "app/models/segment.rb",
+    "app/views/layouts/segment_layout.html.erb",
+    "app/views/segments/_form.html.erb",
+    "app/views/segments/_segment_row.html.erb",
+    "app/views/segments/edit.html.erb",
+    "app/views/segments/index.html.erb",
+    "app/views/segments/show.html.erb",
+    "config/boot.rb",
+    "config/locales/en.yml",
+    "config/routes.rb",
+    "lib/engine.rb",
+    "lib/generators/segments/segments_generator.rb",
+    "lib/generators/segments/templates/segments_migration.rb",
+    "lib/segments.rb",
+    "lib/tasks/segments.rake",
+    "segments.gemspec"
+  ]
+  s.homepage = %q{http://github.com/joshmcarthur/segments}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{A Rails 3 Engine for managing text segments}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<git>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<git>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<git>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: segments
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Josh McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: git
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: A Rails 3 Engine for managing and rendering text segments into your Rails web application. Segments are short-to-medium blocks of text or HTML that you wish to use throughout your application. It includes a web interface for managing segments, and is automatically compatible with Internationalization (I18n)
+email: joshua.mcarthur@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- app/controllers/segments_controller.rb
+- app/models/segment.rb
+- app/views/layouts/segment_layout.html.erb
+- app/views/segments/_form.html.erb
+- app/views/segments/_segment_row.html.erb
+- app/views/segments/edit.html.erb
+- app/views/segments/index.html.erb
+- app/views/segments/show.html.erb
+- config/boot.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/engine.rb
+- lib/generators/segments/segments_generator.rb
+- lib/generators/segments/templates/segments_migration.rb
+- lib/segments.rb
+- lib/tasks/segments.rake
+- segments.gemspec
+homepage: http://github.com/joshmcarthur/segments
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 285984097
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A Rails 3 Engine for managing text segments
+test_files: []
+