newsletter 0.0.1

data/README

@@ -0,0 +1,243 @@
+== 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" designs
+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, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== 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/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) 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 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(: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 you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that 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 enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+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.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/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>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+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.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the design files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the design 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 script/generate 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. Contains subdirectories for images, stylesheets,
+  and javascripts. 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 script/generate scripts, design
+  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.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Newsletter
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Newsletter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/newsletter/application.js

@@ -0,0 +1,15 @@
+// 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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/newsletter/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/newsletter/application_controller.rb

@@ -0,0 +1,27 @@
+require 'dynamic_form'
+require 'nested_form'
+class Newsletter::ApplicationController < ActionController::Base
+  layout 'newsletter/application'
+  helper_method :title, :use_show_for_resources?, :site_url, :show_title?
+  
+  def title(value=nil)
+    @title = value if value.present?
+    @title
+  end
+
+  def show_title?
+    true
+  end
+
+  def use_show_for_resources?
+    ::Newsletter.use_show_for_resources
+  rescue 
+    false
+  end
+
+  def site_url
+    ::Newsletter.site_url
+  rescue
+    "#{default_url_options[:protocol]||'http'}://#{default_url_options[:domain]}"
+  end
+end

data/app/controllers/newsletter/areas_controller.rb

@@ -0,0 +1,63 @@
+module Newsletter 
+  class AreasController < ::Newsletter::ApplicationController
+    
+    before_filter :find_area, :except => [:create, :new, :index]
+    before_filter :find_design, :except => [:destroy,:sort]
+  
+    def sort
+      @newsletter = Newsletter.find(params[:newsletter_id])
+      @area.pieces.active.by_newsletter(@newsletter).each do | piece |
+        piece.update_attribute(:sequence, params["piece"].index(piece.id.to_s).to_i+1)
+      end
+      head :ok
+    end
+  
+    def index
+      @areas = Area.find(:all)
+    end
+
+    def show
+    end
+
+    def new
+      @newsletter_area = Area.new
+    end
+
+    def edit
+    end
+
+    def create
+      @newsletter_area = Area.new(params[:area])
+      if @newsletter_area.save
+        flash[:notice] = 'Area was successfully created.'
+          redirect_to(@newsletter_area)
+      else
+          render :action => "new"
+      end
+    end
+
+    def update
+      if @newsletter_area.update_attributes(params[:area])
+        flash[:notice] = 'Area was successfully updated.'
+        redirect_to(@newsletter_area) 
+      else
+        render :action => "edit"
+      end
+    end
+
+    def destroy
+      @newsletter_area.destroy
+      redirect_to(areas_url)
+    end
+  
+    protected
+  
+    def find_design
+      @design = Design.find(params[:design_id])
+    end
+    
+    def find_area
+      @area = Area.find(params[:id])
+    end
+  end
+end

data/app/controllers/newsletter/designs_controller.rb

@@ -0,0 +1,51 @@
+require 'nested_form'
+module Newsletter
+  class DesignsController < ::Newsletter::ApplicationController
+    before_filter :find_design, :except => [:new, :create, :index]
+
+    def index
+      @designs = Design.find(:all)
+    end
+
+    def show
+      @areas = @design.areas.active
+    end
+
+    def new
+      @design = Design.new
+    end
+
+    def edit
+    end
+
+    def create
+      @design = Design.new(params[:design])
+      if @design.save
+        flash[:notice] = 'Design was successfully created.'
+        redirect_to(edit_design_path(@design))
+      else
+          render :action => "new"
+      end
+    end
+
+    def update
+      if @design.update_attributes(params[:design])
+        flash[:notice] = 'Design was successfully updated.'
+        redirect_to(edit_design_path(@design))
+      else
+        render :action => "edit"
+      end
+    end
+
+    def destroy
+      @design.destroy
+      redirect_to(designs_url)
+    end
+    
+    protected
+    
+    def find_design
+      @design = Design.find(params[:id])
+    end
+  end
+end

data/app/controllers/newsletter/elements_controller.rb

@@ -0,0 +1,75 @@
+module Newsletter
+  class ElementsController < ::Newsletter::ApplicationController
+    before_filter :find_element, :except => [:new,:create,:index]
+    before_filter :find_design
+    before_filter :find_fields, :except => [:new,:create,:index]
+    before_filter :find_field_types, :only => [:new,:create,:edit,:update]
+    include DeleteableActions  
+
+    def index
+      @elements = @design.elements.
+        by_design(@design).paginate(:page => params[:page])
+    end
+
+    def new
+      @element = Element.new
+      @fields = [Field.new]
+    end
+
+    def edit
+    end
+
+    def create
+      @element = Element.new(params[:element])
+      @element.design = @design
+
+      respond_to do |format|
+        if @element.save
+          flash[:notice] = 'Element was successfully created.'
+          format.html { redirect_to(design_elements_path(@design)) }
+          format.xml  { render :xml => @element, :status => :created, :location => @element }
+        else
+          format.html { render :action => "new" }
+          format.xml  { render :xml => @element.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+    
+    def update
+      respond_to do |format|
+        if @element.update_attributes(params[:element])
+          flash[:notice] = 'Element was successfully updated.'
+          format.html { redirect_to(design_elements_path(@design)) }
+          format.xml  { head :ok }
+        else
+          format.html { render :action => "edit" }
+          format.xml  { render :xml => @element.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+
+    def destroy
+      @element.destroy
+      redirect_to(design_elements_path(@design))
+    end
+  
+    protected
+    def find_element
+      @element = Element.find_by_id(params[:id])
+    end
+  
+    def find_design
+      return @design = @element.design if @element
+      @design = Design.find_by_id(params[:design_id])
+    end
+  
+    def find_fields
+      return @fields = @element.fields if @element
+      [Field.new]
+    end
+  
+    def find_field_types
+      @field_types = Field.valid_types
+    end
+  end
+end

data/app/controllers/newsletter/fields_controller.rb

@@ -0,0 +1,49 @@
+module Newsletter
+  class FieldsController < ::Newsletter::ApplicationController  
+    before_filter :find_field, :except => [:index, :new, :create]
+
+    def index
+      @fields = NewsletterField.find(:all)
+    end
+
+    def show
+    end
+
+    def new
+      @field = NewsletterField.new
+    end
+
+    def edit
+    end
+
+    def create
+      @field = Field.new(params[:field])
+      if @field.save
+        flash[:notice] = 'NewsletterField was successfully created.'
+        redirect_to(@field)  
+      else
+        render :action => "new"
+      end
+    end
+
+    def update
+      if @field.update_attributes(params[:field])
+        flash[:notice] = 'Field was successfully updated.'
+        redirect_to(@field)
+      else
+        render :action => "edit"
+      end
+    end
+
+    def destroy
+      @field.destroy
+      redirect_to(fields_url)
+    end
+    
+    protected
+    
+    def find_field
+      @field = Field.find(params[:id])
+    end
+  end
+end

data/app/controllers/newsletter/newsletters_controller.rb

@@ -0,0 +1,104 @@
+module Newsletter
+  class NewslettersController < ::Newsletter::ApplicationController
+    skip_before_filter :authorize, :only => ["archive","show"]
+    before_filter :find_newsletter, :only => [:editor,:publish,:unpublish,:edit,:update,:destroy,:show]
+    #FIXME: why do we need to place this custom code here instead of reopening the class?
+    skip_before_filter :authenticate, :only => [:archive,:show]
+  
+  
+    def sort
+      Newsletter.all.each do | newsletter |
+        newsletter.sequence = params["newsletters"].index(newsletter.id.to_s)+1
+        newsletter.save
+      end
+      head :ok
+    end
+  
+    def archive
+      @newsletters = Newsletter.published
+      render :layout => ::Newsletter.archive_layout
+    end
+  
+    def publish
+      if @newsletter.publish
+        flash[:notice] = 'Newsletter Published'
+      else
+        flash[:notice] = @newsletter.errors
+      end
+      redirect_to(newsletters_path)
+    end
+  
+    def unpublish
+      if @newsletter.unpublish
+        flash[:notice] = 'Newsletter UnPublished'
+      else
+        flash[:notice] = @newsletter.errors
+      end 
+      redirect_to(newsletters_path)
+    end
+  
+    def index
+      @newsletters = ::Newsletter::Newsletter.active.order('created_at desc, published_at desc').paginate(:page => params[:page])
+    end
+  
+    def show
+      return redirect_to(main_app.newsletter_archive_path) unless @newsletter.present?
+      newsletter_html = render_to_string :inline => File.readlines(@newsletter.design.view_path).join, 
+        :locals => @newsletter.locals
+      if params[:mode].eql?('email')
+        #mailer handles substitutions
+        render :text => newsletter_html
+      else
+        #no substitutions
+        render :text => newsletter_html
+      end
+    end
+
+    def editor
+      params[:editor] = '1'
+      newsletter_html = render_to_string :inline => File.readlines(@newsletter.design.view_path).join, 
+        :locals => @newsletter.locals
+      render :text => newsletter_html
+    end
+
+    def new
+      @newsletter = Newsletter.new
+      @designs = Design.active
+    end
+
+    def edit
+      @designs = Design.active
+    end
+
+    def create
+      @newsletter = Newsletter.new(params[:newsletter])
+      if @newsletter.save
+        flash[:notice] = 'Newsletter was successfully created.'
+        redirect_to(edit_newsletter_path(@newsletter))
+      else
+        @designs = Design.active
+        render :action => "new"
+      end
+    end
+
+    def update
+      if @newsletter.update_attributes(params[:newsletter])
+        flash[:notice] = 'Newsletter was successfully updated.'
+        redirect_to(edit_newsletter_path(@newsletter))
+      else
+        @designs = Design.active
+        render :action => "edit"
+      end
+    end
+
+    def destroy
+      @newsletter.destroy
+      redirect_to(newsletters_url)
+    end
+  
+    protected 
+    def find_newsletter
+      @newsletter = Newsletter.find_by_id(params[:id])
+    end
+  end
+end