effective_regions 1.0.0

data/app/models/effective/templates/image_and_title.rb

@@ -0,0 +1,13 @@
+module Effective
+  module Templates
+    class ImageAndTitle < Template
+      def title
+        'Image and Title'
+      end
+
+      def description
+        'yo, One main image with a title and text that surround the image.'
+      end
+    end
+  end
+end

data/app/models/effective/templates/template.rb

@@ -0,0 +1,26 @@
+module Effective
+  module Templates
+    class Template
+      def title
+        class_name.to_s.humanize
+      end
+
+      def description
+        "Insert #{title}"
+      end
+
+      def image
+        "#{class_name}.png"
+      end
+
+      def to_partial_path
+        "effective/templates/#{class_name}"
+      end
+
+      def class_name
+        @class_name ||= self.class.name.demodulize.underscore.to_sym
+      end
+
+    end
+  end
+end

data/app/views/effective/snippets/_current_user_info.html.haml

@@ -0,0 +1,10 @@
+- if current_user.present? == false
+  = 'Not logged in'
+- elsif current_user_info.method == 'email'
+  = (current_user.email rescue '')
+- elsif current_user_info.method == 'full_name'
+  = (current_user.full_name rescue '')
+- elsif current_user_info.method == 'first_name'
+  = (current_user.first_name rescue '')
+- elsif current_user_info.method == 'last_name'
+  = (current_user.last_name rescue '')

data/app/views/effective/templates/_image_and_title.html.haml

@@ -0,0 +1,5 @@
+%h3
+  %img{:src => '', :alt => '', :style => 'margin-right: 10px', :height => '100', :width => '100', :align => 'left'}
+  Type the title here
+%p
+  Type the text here

data/config/routes.rb

@@ -0,0 +1,19 @@
+Rails.application.routes.draw do
+  mount EffectiveRegions::Engine => '/', :as => 'effective_regions'
+end
+
+EffectiveRegions::Engine.routes.draw do
+  scope :module => 'effective' do
+    scope '/effective' do
+      get 'snippets' => 'regions#snippets', :as => :snippets # Index of all Snippets
+      get 'snippet/:id' => 'regions#snippet', :as => :snippet # Get a Snippet based on passed values
+
+      get 'templates' => 'regions#templates', :as => :templates # Index of all Templates
+    end
+
+    scope '/edit' do  # Changing this, means changing the effective_ckeditor routes
+      get '(*requested_uri)' => 'regions#edit', :as => :edit_effective_regions
+      put '(*requested_uri)' => 'regions#update', :as => :effective_regions
+    end
+  end
+end

data/db/migrate/01_create_effective_regions.rb.erb

@@ -0,0 +1,23 @@
+class CreateEffectiveRegions < ActiveRecord::Migration
+  def self.up
+    create_table <%= @regions_table_name %> do |t|
+      t.string :regionable_type
+      t.integer :regionable_id
+
+      t.string :title
+      t.text :content
+      t.text :snippets
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index <%= @regions_table_name %>, [:regionable_type, :regionable_id]
+    add_index <%= @regions_table_name %>, :regionable_id
+  end
+
+  def self.down
+    drop_table <%= @regions_table_name %>
+  end
+
+end

data/lib/effective_regions.rb

@@ -0,0 +1,57 @@
+require "effective_regions/engine"
+require "effective_regions/version"
+
+module EffectiveRegions
+  mattr_accessor :regions_table_name
+  mattr_accessor :authorization_method
+  mattr_accessor :before_save_method
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
+      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
+    end
+    true
+  end
+
+  # Returns a Snippet.new() for every class in the /app/effective/snippets/* directory
+  def self.snippets
+    Rails.env.development? ? read_snippets : (@@snippets ||= read_snippets)
+  end
+
+  # Returns a Template.new() for every class in the /app/effective/templates/* directory
+  def self.templates
+    Rails.env.development? ? read_templates : (@@templates ||= read_templates)
+  end
+
+  private
+
+  def self.read_snippets
+    # Reversing here so the app's templates folder has precedence.
+    files = ApplicationController.view_paths.map { |path| Dir["#{path}/effective/snippets/**"] }.flatten.reverse
+
+    files.map do |file|
+      snippet = File.basename(file)
+      snippet = snippet[1...snippet.index('.') || snippet.length] # remove the _ and .html.haml
+
+      "Effective::Snippets::#{snippet.try(:classify)}".constantize.new()
+    end
+
+  end
+
+  def self.read_templates
+    # Reversing here so the app's templates folder has precedence.
+    files = ApplicationController.view_paths.map { |path| Dir["#{path}/effective/templates/**"] }.flatten.reverse
+
+    files.map do |file|
+      template = File.basename(file)
+      template = template[1...template.index('.') || template.length] # remove the _ and .html.haml
+
+      "Effective::Templates::#{template.try(:classify)}".constantize.new()
+    end
+  end
+
+end

data/lib/effective_regions/engine.rb

@@ -0,0 +1,27 @@
+module EffectiveRegions
+  class Engine < ::Rails::Engine
+    engine_name 'effective_regions'
+
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+
+    # Include Helpers to base application
+    initializer 'effective_regions.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper EffectiveRegionsHelper
+      end
+    end
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_regions.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(ActsAsRegionable::ActiveRecord)
+      end
+    end
+
+    # Set up our default configuration options.
+    initializer "effective_regions.defaults", :before => :load_config_initializers do |app|
+      eval File.read("#{config.root}/lib/generators/templates/effective_regions.rb")
+    end
+
+  end
+end

data/lib/effective_regions/version.rb

@@ -0,0 +1,3 @@
+module EffectiveRegions
+  VERSION = '1.0.0'
+end

data/lib/generators/effective_regions/install_generator.rb

@@ -0,0 +1,32 @@
+module EffectiveRegions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates an EffectiveRegions initializer in your application."
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template "effective_regions.rb", "config/initializers/effective_regions.rb"
+      end
+
+      def create_migration_file
+        @regions_table_name = ':' + EffectiveRegions.regions_table_name.to_s
+        migration_template '../../../db/migrate/01_create_effective_regions.rb.erb', 'db/migrate/create_effective_regions.rb'
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectiveRegions

data/lib/generators/templates/effective_regions.rb

@@ -0,0 +1,71 @@
+EffectiveRegions.setup do |config|
+  config.regions_table_name = :regions
+
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| true }
+
+
+  # Before Region Save Method
+  #
+  # This method is called when a User clicks the 'Save' button in the full screen editor.
+  # It will be called once for each region immediately before the regions are saved to the database.
+  #
+  # This is not an ActiveRecord before_save callback and there is no way to cancel the save.
+  #
+  # This method is run on the controller.view_context, so you have access to all your regular
+  # view helpers as well as the request object.
+  #
+  # The second argument, 'parent', will be the Effective::Region's parent regionable object, or the symbol :global
+  #
+  # If you are gsub'ing the region.content String value or altering the region.snippets Hash values,
+  # those changes will not be immediately visible on the front-end.
+  #
+  # If you need the user to immediately see these changes, have your Proc or function return the symbol :refresh
+  #
+  # Returning the symbol :refresh will instruct javascript to perform a full page refresh after the Save is complete.
+  #
+  # Don't change the region.title, as this will orphan the region
+  #
+  # Use via Proc:
+  #
+  # config.before_save_method = Proc.new do |region, parent|
+  #   region.content = region.content.gsub('force', 'horse') if region.title == 'body'
+  #   :refresh
+  # end
+  #
+  # Use via custom method:
+  # config.before_save_method = :my_region_before_save_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_region_before_save_method(region, parent)
+  #   if region.title == 'body' && request.fullpath == posts_path
+  #     region.content = region.content.gsub('force', 'horse')
+  #     :refresh
+  #   end
+  # end
+  #
+  # Or disable the callback completely:
+  # config.before_save_method = false
+
+  config.before_save_method = false
+
+end

data/lib/tasks/effective_regions_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :effective_regions do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.