editable_areas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0586b45e191c4d27b12c82df899a4f84219505b0
+  data.tar.gz: aa19867980c9d2deda1a4babfc9f1f44e64f5fef
+SHA512:
+  metadata.gz: 7f6705a0c81ddcd8eb0f6674b35ab56f80acd1e7f55f8fdad0fb228bc3b8bb455436dee96afea9a2602e943e617bde10325b2c1fc694dba3ff7a1ea8f4e565e0
+  data.tar.gz: cc32bebef5a017cc185eeaafdb679bc1f65e39cd3527f25e9e745aa4b54dc97d6e77b93672598a26bcd0b147d6aa3567e4f09591c853cf97505e58e786622e10

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.0.0"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kainage
+
+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,77 @@
+# Editable Areas
+
+[![Build Status](https://travis-ci.org/kainage/editable_areas.png)](https://travis-ci.org/kainage/editable_areas)
+
+Requires ruby >= **v2.0** 
+Requires rails >= **v4.0.0.rc1**
+
+Renders text or an editor anywhere in your rails 4 application
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'editable_areas'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install editable_areas
+
+Run the generator:
+
+    $ rails g editable_areas
+
+This will create the migration file.
+
+Migrate the database:
+
+    $ rake db:migrate
+
+## Usage
+
+Add one of the helper methods to one of your pages:
+
+```
+<%= render_or_edit_area_with_button(title: 'Title' accessible: true) %>
+```
+The accessible option will hide the edit button and never render the editable form
+(will always render the content) if false. Pass in an _admin_ or _moderator_ etc.
+check here.
+
+You will now have a blank div with the class "editable_area" and an edit button.
+Clicking on the edit button will return you to the same page, but there will be a
+textarea for you to edit.
+
+Submitting the form will return you to the same page with the content loaded and
+the edit button back in place (if accessible)
+
+Note that even if an unauthorized user appends _?edit=true_ to the url, it will
+not render the form unless ```accessible = true```
+
+If you want to render the form/content and the button separately you can:
+
+```
+<%= render_or_edit_area(title: 'Title', accessible: true) %> # Renders only the content or form
+
+<%= render_edit_area_button(accessible: true) %> # Renders only the edit button
+```
+
+By default the textarea has a class of "ckeditor" if you want to hook into that
+or you use the _ckeditor-rails_ gem. If not, you can just ignore this.
+
+### CanCan integration
+
+If you are using CanCan for authorization, the ```EditableAreasController``` will
+automatically add authorization to the _update_ action with ```authorize! :update, @editable_area```.
+
+## 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,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/editable_areas_controller.rb

@@ -0,0 +1,24 @@
+class EditableAreasController < ApplicationController
+  # PATCH/PUT /editable_area/1
+	# PATCH/PUT /editable_area/1.json
+  def update
+    @editable_area = EditableArea.find(params[:id])
+    authorize! :update, @editable_area if defined? CanCan::Ability
+
+    respond_to do |format|
+      if @editable_area.update_attributes(editable_area_params)
+        format.html { redirect_to request.referrer.split('?').first, notice: 'Editable area was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { redirect_to request.referrer, notice: @editable_area.errors.full_messages.join(', ') }
+        format.json { render json: @editable_area.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  private
+
+  def editable_area_params
+    params.require(:editable_area).permit(:content)
+  end
+end

data/app/helpers/editable_areas_helper.rb

@@ -0,0 +1,21 @@
+module EditableAreasHelper
+  def render_or_edit_area(title, accessible: true)
+    editable_area = EditableArea.place(title)
+
+    if params[:edit] && accessible
+      render 'editable_areas/form', :editable_area => editable_area
+    else
+      render editable_area
+    end
+  end
+
+  def render_edit_area_button(accessible: true)
+    link_to 'Edit', request.fullpath + '?edit=true', :class => 'editable_area_btn' if params[:edit].blank? && accessible
+  end
+
+  def render_or_edit_area_with_button(title, accessible: true)
+    content_tag :div, :class => 'editable_area' do
+      render_or_edit_area(title, accessible: accessible) + render_edit_area_button(accessible: accessible)
+    end.html_safe
+  end
+end

data/app/models/editable_area.rb

@@ -0,0 +1,3 @@
+class EditableArea < ActiveRecord::Base
+  include EditableAreas::EditableAreaAdditions
+end

data/app/views/editable_areas/_editable_area.html.erb

@@ -0,0 +1 @@
+<%= raw editable_area.content %>

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

@@ -0,0 +1,20 @@
+<%= form_for(editable_area) do |f| %>
+  <% if editable_area.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(area.errors.count, "error") %> prohibited this editable area from being saved:</h2>
+
+      <ul>
+        <% editable_area.errors.full_messages.each do |msg| %>
+          <li><%= msg %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.text_area :content, :class => 'ckeditor' %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :editable_areas, only: :update
+end

data/editable_areas.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'editable_areas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "editable_areas"
+  spec.version       = EditableAreas::VERSION
+  spec.authors       = ["Kainage"]
+  spec.email         = ["kainage@gmail.com"]
+  spec.description   = %q{Renders text or an editor anywhere in your rails 4 application}
+  spec.summary       = %q{Renders text or an editor anywhere in your rails 4 application}
+  spec.homepage      = "https://github.com/kainage/editable_area"
+  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 "rails", "~> 4.0.0.rc1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "rspec-rails"
+end

data/lib/editable_areas.rb

@@ -0,0 +1,4 @@
+require 'editable_areas/engine'
+
+require 'editable_areas/version'
+require 'editable_areas/editable_area_additions'

data/lib/editable_areas/editable_area_additions.rb

@@ -0,0 +1,11 @@
+module EditableAreas
+  module EditableAreaAdditions
+    def self.included(editable_area_model)
+      editable_area_model.validates :title, presence: true
+
+      def editable_area_model.place(title)
+        self.where(title: title).first_or_create
+      end
+    end
+  end
+end

data/lib/editable_areas/engine.rb

@@ -0,0 +1,9 @@
+module EditableAreas
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/editable_areas/version.rb

@@ -0,0 +1,3 @@
+module EditableAreas
+  VERSION = "0.0.1"
+end

data/lib/generators/editable_areas_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/migration'
+
+class EditableAreasGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path("../templates", __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_editable_areas_files
+    migration_template "create_editable_areas.rb", "db/migrate/create_editable_areas.rb"
+  end
+end

data/lib/generators/templates/create_editable_areas.rb

@@ -0,0 +1,12 @@
+class CreateEditableAreas < ActiveRecord::Migration
+  def change
+    create_table :editable_areas do |t|
+      t.string :title, null: false
+      t.text :content
+
+      t.timestamps
+    end
+
+    add_index :editable_areas, :title
+  end
+end

data/spec/controllers/areas_controller_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe EditableAreasController do
+	before :each do
+		request.env["HTTP_REFERER"] = "http://localhost:3000"
+	end
+
+	def valid_attributes
+		{ "title" => "MyString" }
+	end
+
+	describe "PUT update" do
+		describe "with valid params" do
+			it "updates the requested editable_area" do
+				editable_area = EditableArea.create! valid_attributes
+				# Assuming there are no other editable_areas in the database, this
+				# specifies that the Area created on the previous line
+				# receives the :update_attributes message with whatever params are
+				# submitted in the request.
+				EditableArea.any_instance.should_receive(:update_attributes).with({ "content" => "MyString" })
+				put :update, {:id => editable_area.to_param, :editable_area => { "content" => "MyString" }}
+			end
+
+			it "assigns the requested editable_area as @editable_area" do
+				editable_area = EditableArea.create! valid_attributes
+				put :update, {:id => editable_area.to_param, :editable_area => valid_attributes}
+				assigns(:editable_area).should eq(editable_area)
+			end
+
+			it "redirects to the editable_area" do
+				editable_area = EditableArea.create! valid_attributes
+				put :update, {:id => editable_area.to_param, :editable_area => valid_attributes}
+				response.should redirect_to(request.referrer)
+			end
+		end
+
+		describe "with invalid params" do
+			it "assigns the editable_area as @editable_area" do
+				editable_area = EditableArea.create! valid_attributes
+				# Trigger the behavior that occurs when invalid params are submitted
+				EditableArea.any_instance.stub(:save).and_return(false)
+				put :update, {:id => editable_area.to_param, :editable_area => { "title" => "invalid value" }}
+				assigns(:editable_area).should eq(editable_area)
+			end
+
+			it "re-renders the 'edit' template" do
+				editable_area = EditableArea.create! valid_attributes
+				# Trigger the behavior that occurs when invalid params are submitted
+				EditableArea.any_instance.stub(:save).and_return(false)
+				put :update, {:id => editable_area.to_param, :editable_area => { "title" => "invalid value" }}
+				response.should redirect_to(request.referrer)
+			end
+		end
+	end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== 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
+<tt>rake doc:app</tt>.