acts-as-layoutable 0.0.1.7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com)
+ 
+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.markdown

@@ -0,0 +1,50 @@
+# ActsAsLayoutable
+
+## Usage
+
+### Install
+
+    sudo gem install acts-as-layoutable
+
+### Usage
+
+    Layoutable do
+      # defines valid areas
+      areas :top, :bottom, :left, :right, :header, :footer, :center
+      
+      grids do
+        full :top, :bottom, :left, :right, :center
+        left :top, :bottom, :right
+        portfolio :top, :bottom, :center
+        blog do
+          right :text, :social
+        end
+      end
+      
+      widgets do
+        text do
+          title :string, :label => "Sample text"
+          body :text
+        end
+        
+        social do
+          links :as => Link
+        end
+      end
+    end
+
+That creates cells, areas, and layouts.
+
+### Api
+
+    Layoutable.widgets #=> [text, social]
+    Layoutable.areas #=> [:top, :bottom, :left, :right, :header, :footer, :center]
+    Layoutable.layouts #=> [:full, :left, :portfolio]
+    layout = Layout.first
+    layout.widgets
+    layout.top_widgets
+    layout.bottom_widgets
+    
+- Each `Post` has a different `Layout` via `clone`.
+- New layouts cannot be constructed outside of this dsl.  Only the order and presence of cells within areas can be customized.
+- `area` is the "context" for the join of Layout to Widget.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "acts-as-layoutable"
+  s.authors           = ["Lance Pollard"]
+  s.version           = "0.0.1.7"
+  s.summary           = "ActsAsLayoutable: Super Complex Layouts in Rails with single Configuration file"
+  s.homepage          = "http://github.com/viatropos/acts-as-layoutable"
+  s.email             = "lancejpollard@gmail.com"
+  s.description       = "Super Complex Layouts in Rails with single Configuration file"
+  s.has_rdoc          = false
+  s.rubyforge_project = "acts-as-layoutable"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,rails,test}/**/*"] - Dir["test/tmp"]
+  s.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc 'run unit tests'
+task :test do
+  Dir["test/**/*"].each do |file|
+    next unless File.basename(file) =~ /test_/
+    next unless File.extname(file) == ".rb"
+    system "ruby #{file}"
+  end
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  command = "gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc"
+  command = "sudo #{command}" if ENV["SUDO"] == true
+  sh %{#{command}}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/init.rb

@@ -0,0 +1 @@
+File.dirname(__FILE__) + "/rails/init.rb"

data/lib/acts-as-layoutable.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+require 'cockpit'
+require 'acts-as-joinable'
+
+def require_local(path, from = __FILE__)
+  files(path, from) {|file| require file if File.extname(file) == ".rb"}
+end
+
+def files(path, from = __FILE__, &block)
+  Dir.glob(File.expand_path(File.join(File.dirname(from), path))) {|file| yield file}
+end
+
+module ActsAsLayoutable
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, InstanceMethods
+  end
+  
+  module ClassMethods
+
+    def acts_as_layoutable(*args)
+      acts_as_joinable_on :layouts, :class_name => "ActsAsLayoutable::Layout"
+      # before_save :ensure_layout_exists
+      
+      options = args.extract_options!
+      
+      args.each do |action|
+        define_method "#{action.to_s}_layout" do
+          join_for(:parent, :layout, action)
+        end
+        define_method "#{action.to_s}_layout=" do |value|
+          set_joined(:parent, :layout, action, value)
+        end
+        define_method "#{action.to_s}_layout_id" do
+          result = join_for(:parent, :layout, action)
+          result ? result.id : nil
+        end
+        define_method "#{action.to_s}_layout_id=" do |value|
+          set_joined(:parent, :layout, action, value)
+        end
+      end
+    end
+    
+    def template(layoutable)
+      layoutable ? layoutable.template : nil
+    end
+  end
+  
+  module InstanceMethods
+    
+    def ensure_layout_exists
+      if self.layouts.blank?
+        self.layouts << Layout.first
+      end
+    end
+    
+    def layout
+      self.layouts.first
+    end
+    
+    def template
+      self.layout.template
+    end
+  end
+  
+end
+
+require File.dirname(__FILE__) + '/acts-as-layoutable/builder'
+require_local "acts-as-layoutable/*"
+
+ActiveRecord::Base.send(:include, ActsAsLayoutable)
+
+def Layoutable(*args, &block)
+  ActsAsLayoutable::Builder.define!(*args, &block)
+end
+
+def Layouts(*args, &block)
+  Layoutable(*args, &block)
+end

data/lib/acts-as-layoutable/area.rb

@@ -0,0 +1,21 @@
+module ActsAsLayoutable
+  
+  class AreaBuilder < ActsAsLayoutable::Builder
+    
+    def method_missing(meth, *args, &block)
+      self.item = ActsAsLayoutable::Area.create!(:name => meth.to_s)
+      args.each do |widget|
+        self.item.widgets << ActsAsLayoutable::Widget.find_or_create_by_name(widget.to_s)
+      end
+      self.collection << self.item
+      self.item.save
+      self.item
+    end
+    
+  end
+  
+  class Area < ActiveRecord::Base
+    belongs_to :layout
+    has_many   :widgets
+  end
+end

data/lib/acts-as-layoutable/builder.rb

@@ -0,0 +1,61 @@
+module ActsAsLayoutable
+  class Builder
+    
+    class << self
+      def define!(*args, &block)
+        new(*args, &block).collection.uniq
+      end
+    end
+    
+    attr_accessor :item, :collection
+    
+    def collection
+      @collection ||= []
+    end
+
+    def klazz
+      self.class.to_s.gsub("Builder", "").constantize
+    end
+    
+    def initialize(*args, &block)
+      args.each do |name|
+        self.collection << klazz.create!(:name => name.to_s)
+      end
+      instance_eval(&block) if block_given?
+    end
+    
+    def templates(*args, &block)
+      TemplateBuilder.define!(*args, &block)
+    end
+    alias paths templates
+    
+    def layouts(*args, &block)
+      LayoutBuilder.define!(*args, &block)
+    end
+    alias grids layouts
+    
+    def areas(*args, &block)
+      AreaBuilder.define!(*args, &block)
+    end
+    
+    def widgets(*args, &block)
+      WidgetBuilder.define!(*args, &block)
+    end
+    alias cells widgets
+    
+    def method_missing(meth, *args, &block)
+      if context
+        result = "ActsAsLayoutable::#{context.singularize.camelize}".constantize.new
+        result.instance_eval(&block) if block_given?
+        return result
+      else
+        super(meth, *args, &block)
+      end
+    end
+    
+    private
+      def context
+        @context
+      end
+  end
+end

data/lib/acts-as-layoutable/layout.rb

@@ -0,0 +1,52 @@
+module ActsAsLayoutable
+  
+  class LayoutBuilder < ActsAsLayoutable::Builder
+    
+    # the path to the template/view folder, so "app/views/posts" is "posts"
+    def template(path = nil)
+      self.item.path = path.to_s if path
+    end
+    alias path template
+    
+    # the REST actions your layout will respond to
+    def actions(*args)
+    end
+    
+    def description(text = nil)
+      self.item.description = text.to_s if text
+    end
+    
+    def areas(*args, &block)
+      ActsAsLayoutable::AreaBuilder.define!(*args, &block).each do |area|
+        self.item.areas << area
+      end
+    end
+    
+    def method_missing(meth, *args, &block)
+      self.item = ActsAsLayoutable::Layout.find_or_create_by_name(meth.to_s)
+      self.instance_eval(&block) if block_given?
+      self.item.save
+      self.collection << item
+      self.item
+    end
+    
+  end
+  
+  class Layout < ActiveRecord::Base
+    acts_as_joinable
+    has_many :areas, :class_name => "ActsAsLayoutable::Area"
+    has_many :widgets, :class_name => "ActsAsLayoutable::Widget", :through => :areas
+    before_save :assure_key
+    
+    validates_presence_of :name
+    
+    def assure_key
+      self.key ||= self.name.underscore.downcase.gsub(/\s+/, "_")
+    end
+    
+    def template
+      raise "Layout doesn't have a template" unless self.path
+      self.path
+    end
+  end
+end

data/lib/acts-as-layoutable/template.rb

@@ -0,0 +1,32 @@
+module ActsAsLayoutable
+  
+  class TemplateBuilder < ActsAsLayoutable::Builder
+    
+    def method_missing(meth, *args, &block)
+      key = meth.to_s
+      path = args.shift || key.dup
+      template = ActsAsLayoutable::Template.new(path, key)
+      Template.all << template
+      self.collection << template
+      template
+    end
+    
+  end
+  
+  class Template
+    attr_accessor :path, :key
+    
+    def initialize(path, key)
+      @path = path
+      @key = key
+    end
+    
+    class << self
+      attr_accessor :all
+      
+      def all
+        @all ||= []
+      end
+    end
+  end
+end

data/lib/acts-as-layoutable/widget.rb

@@ -0,0 +1,18 @@
+module ActsAsLayoutable
+  
+  class WidgetBuilder < ActsAsLayoutable::Builder
+    
+    def method_missing(meth, *args, &block)
+      self.item = ActsAsLayoutable::Widget.create!(:name => meth.to_s)
+      ActsAsLayoutable::Widget.acts_as_configurable(meth, &block) if block_given?
+      self.collection << self.item
+      self.item.save
+      self.item
+    end
+    
+  end
+  
+  class Widget < ActiveRecord::Base
+    belongs_to :area, :class_name => "ActsAsLayoutable::Area"
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'acts-as-layoutable'
+
+ActiveRecord::Base.send :include, ActsAsLayoutable

data/test/lib/database.rb

@@ -0,0 +1,49 @@
+begin
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+rescue ArgumentError
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+end
+
+ActiveRecord::Base.configurations = true
+
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :layouts, :force => true do |t|
+    t.text :description
+    t.string :name
+    t.string :path # path to the layout, same as the 'render' method
+    t.string :key # some layouts use same views, but have different sub areas
+    t.timestamps
+  end
+  
+  create_table :areas, :force => true do |t|
+    t.string :name
+    t.references :layout
+    t.timestamps
+  end
+  
+  create_table :widgets, :force => true do |t|
+    t.string :name
+    t.references :area
+    t.string :type
+    t.timestamps
+  end
+  
+  create_table :links, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+  
+  create_table :pages, :force => true do |t|
+    t.string :title
+    t.timestamps
+  end
+  
+  create_table :relationships do |t|
+    t.references :parent, :polymorphic => true
+    t.references :child, :polymorphic => true
+    t.string :context
+    t.timestamps
+  end
+
+end

data/test/lib/link.rb

@@ -0,0 +1,3 @@
+class Link < ActiveRecord::Base
+  
+end

data/test/lib/page.rb

@@ -0,0 +1,3 @@
+class Page < ActiveRecord::Base
+  acts_as_layoutable
+end

data/test/lib/widgets.rb

@@ -0,0 +1,13 @@
+class TextWidget < ActsAsLayoutable::Widget
+  settings do
+    title :string
+    body :text
+  end
+end
+
+class SocialWidget < ActsAsLayoutable::Widget
+  settings do
+    title :string
+    body :text
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,155 @@
+require "rubygems"
+require "ruby-debug"
+gem 'test-unit'
+require "test/unit"
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda'
+require 'shoulda/active_record'
+require 'acts-as-joinable'
+
+this = File.expand_path(File.dirname(__FILE__))
+require this + '/lib/database'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '/../lib/acts-as-layoutable'))
+
+require File.dirname(__FILE__) + '/lib/link'
+require File.dirname(__FILE__) + '/lib/page'
+
+ActiveRecord::Base.class_eval do
+  def self.detonate
+    all.map(&:destroy)
+  end
+end
+
+ActiveSupport::TestCase.class_eval do
+  
+  def load_layouts
+    Layoutable do
+
+      templates do
+        contact
+        error
+        overview
+        pages
+        large_portfolio "portfolio/large"
+        medium_portfolio "portfolio/medium"
+        small_portfolio "portfolio/small"
+        posts
+      end
+      
+      layouts do
+        full do
+          description "A full width layout, mainly for text"
+          areas       :top, :bottom, :left, :right, :header, :footer, :body
+          template    :pages
+        end
+        left do
+          description "Side bar on the right, content on the left"
+          template    :pages
+          areas       :top, :bottom, :right, :header, :footer, :body 
+        end
+        right do
+          description "Side bar on the left, content on the right"
+          template    :pages
+          areas       :top, :bottom, :left, :header, :footer, :body 
+        end
+        blog do
+          description "Blog Layout"
+          template    :posts
+          areas       :right, :top, :bottom, :header, :footer, :body
+        end
+        page do
+          description "Page Layout"
+          template    :pages
+          areas       :right, :top, :bottom, :header, :footer, :body
+        end
+        contact do
+          description "Contact Layout"
+          template    :contact
+          areas       :top, :bottom, :header, :footer, :body
+        end
+        overview do
+          description "Overview Layout"
+          template    :overview
+          areas       :top, :bottom, :header, :footer, :body
+        end
+        large_portfolio do
+          description "Large Portfolio Layout"
+          template    :large_portfolio
+          areas       :top, :bottom, :header, :footer, :body
+        end
+        medium_portfolio do
+          description "Medium Portfolio Layout"
+          template    :medium_portfolio
+          areas       :top, :bottom, :header, :footer, :body
+        end
+        small_portfolio do
+          description "Small Portfolio Layout"
+          template    :small_portfolio
+          areas       :top, :bottom, :header, :footer, :body
+        end
+      end
+
+      widgets do
+        connect do
+          title :string
+          facebook :string
+          twitter :string
+          my_space :string
+          linked_in :string
+          stack_overflow :string
+          github :string
+          email :string
+        end
+        image do
+          title :string
+          url :string
+          alt_text :string
+          image_title :string
+          description :string
+          image_align :string
+          link_url :string
+        end
+        links do
+          title "Blog Roll"
+        end
+        login do
+          title "Login"
+          google true
+          facebook true
+          twitter true
+          open_id true
+        end
+        meta do
+          title "Meta"
+        end
+        search do
+          title "Search"
+        end
+        social do
+          title "Social"
+        end
+        tag_cloud do
+          title "Tag Cloud"
+        end
+        text do
+          title "Random Text"
+          body :string
+        end
+      end
+
+    end
+    
+  end
+  
+  def detonate
+    ActsAsLayoutable::Layout.detonate
+    ActsAsLayoutable::Area.detonate
+    ActsAsLayoutable::Widget.detonate
+    Page.detonate
+    Link.detonate
+  end
+end

data/test/test_layout.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LayoutTest < ActiveSupport::TestCase
+  
+  context "Layout" do
+    
+    setup do
+      detonate
+      load_layouts
+    end
+    
+    should "load the layouts" do
+      assert_equal 10, ActsAsLayoutable::Layout.count
+      assert_equal 7, ActsAsLayoutable::Area.count(:select => "DISTINCT name")
+      assert_equal 9, ActsAsLayoutable::Widget.count(:select => "DISTINCT name")
+    end
+    
+    should "associate the correct areas to the layouts" do
+      blog = ActsAsLayoutable::Layout.find_by_name("blog")
+      assert_equal 6, blog.areas.length
+    end
+    
+    context "create layouts for model" do
+      setup do
+        @page = Page.create!(:title => "Page title!")
+        @page.layouts << ActsAsLayoutable::Layout.first
+      end
+      
+      should "have one layout" do
+        assert_equal 1, @page.layouts.length
+      end
+    end
+    
+    teardown do
+      detonate
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: acts-as-layoutable
+version: !ruby/object:Gem::Version 
+  hash: 69
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  - 7
+  version: 0.0.1.7
+platform: ruby
+authors: 
+- Lance Pollard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Super Complex Layouts in Rails with single Configuration file
+email: lancejpollard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- init.rb
+- MIT-LICENSE
+- lib/acts-as-layoutable/area.rb
+- lib/acts-as-layoutable/builder.rb
+- lib/acts-as-layoutable/layout.rb
+- lib/acts-as-layoutable/template.rb
+- lib/acts-as-layoutable/widget.rb
+- lib/acts-as-layoutable.rb
+- rails/init.rb
+- test/lib/database.rb
+- test/lib/link.rb
+- test/lib/page.rb
+- test/lib/widgets.rb
+- test/test_helper.rb
+- test/test_layout.rb
+has_rdoc: true
+homepage: http://github.com/viatropos/acts-as-layoutable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: acts-as-layoutable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "ActsAsLayoutable: Super Complex Layouts in Rails with single Configuration file"
+test_files: []
+