modular 0.1

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/TODO

@@ -0,0 +1,2 @@
+* Fix autotest discovery to use one autotest, not two separate
+* Use custom context

data/autotest/discover.rb

@@ -0,0 +1,12 @@
+Autotest.add_discovery { "rspec2" }
+
+Autotest.add_hook :initialize do |at|
+  at.add_mapping(%r%^spec/.*\.rb$%) { |filename, _|
+    
+    filename
+  }
+  
+  %w{.git .svn .hg .DS_Store ._* spec/helpers spec/testdata}.each do |exception|
+    at.add_exception(exception)
+  end
+end

data/lib/generators/component/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates modular component.
+
+Example:
+    rails generate component Thing
+
+    This will create:
+        Component: app/components/thing.rb
+        View: app/views/components/thing.html.erb

data/lib/generators/component/component_generator.rb

@@ -0,0 +1,16 @@
+class ComponentGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def generate_template
+    template "component.rb.erb", "app/components/#{filename}.rb"  
+  end
+  
+  def generate_controller
+    template "template.erb", "app/views/components/#{filename}.html.erb"  
+  end
+  
+  private
+  def filename
+    name.underscore
+  end
+end

data/lib/generators/component/templates/component.rb.erb

@@ -0,0 +1,6 @@
+class Modular::Components::<%=filename.camelize%> < Modular::Components::Base
+  def execute
+  end
+end
+
+<%=filename.camelize%> = Modular::Components::<%=filename.camelize%> 

data/lib/generators/component/templates/template.erb

@@ -0,0 +1,2 @@
+<h3>Template for <%=filename.camelize%></h3>
+

data/lib/modular/abstract_model.rb

@@ -0,0 +1,74 @@
+require 'active_model'
+
+module Modular
+  module Helpers
+    class AbstractModel
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+      extend ActiveModel::Naming
+    
+      def initialize(attributes = {})
+        @attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+        
+        attributes.each do |name, value|
+          @attributes[name.to_s] = value
+        end
+      end
+      
+      def persisted?
+        false
+      end
+      
+      def to_json
+        ActiveSupport::JSON.encode @attributes.merge({:type => type})
+      end
+        
+      def self.attr_reader(*fields)
+        fields.each do |field|
+          class_eval <<EOF
+        def #{field}
+          @attributes['#{field}']
+        end
+EOF
+        end
+      end
+        
+      def self.attr_writer(*fields)
+        fields.each do |field|
+          class_eval <<EOF
+        def #{field}=(value)
+          @attributes['#{field}']=value
+        end
+EOF
+        end
+      end
+      
+      def self.attr_accessor(*fields)
+        fields.each do |field|
+          attr_writer field
+          attr_reader field
+        end
+      end
+      
+      def self.attr_accessor_with_default(sym, default = Proc.new)
+        define_method(sym, block_given? ? default : Proc.new { default })
+        module_eval(<<-EVAL, __FILE__, __LINE__ + 1)
+          def #{sym}=(value)                          # def age=(value)
+            class << self; attr_accessor :#{sym} end  #   class << self; attr_accessor :age end
+            @attributes['#{sym}']=value               #   @attributes['age'] = value
+          end                                         # end
+        EVAL
+      end
+
+      def self.attr_reader_with_default(sym, default = Proc.new)
+        define_method(sym, block_given? ? default : Proc.new { default })
+        module_eval(<<-EVAL, __FILE__, __LINE__ + 1)
+          def #{sym}=(value)                          # def age=(value)
+            class << self; attr_reader :#{sym} end    #   class << self; attr_accessor :age end
+            @attributes['#{sym}']=value               #   @attributes['age'] = value
+          end                                         # end
+        EVAL
+      end
+    end
+  end
+end

data/lib/modular/caching.rb

@@ -0,0 +1,62 @@
+module Modular
+  module Components
+    module Caching
+      def self.included(base)
+        base.cattr_accessor :cache_options
+        
+        base.class_eval do
+          def self.cache(*args, &block)
+            self.cache_options = args.extract_options!
+            self.cache_options[:cache_key] = block if block_given?
+          end
+        end
+      end
+      
+      def render
+        if cache_options.nil?
+          super
+        elsif cached?
+          get_cached
+        else
+          data = super
+          do_caching data
+          data
+        end
+      end
+
+      def cache_store
+        ::ActionController::Base.cache_store
+      end
+      
+      def cache_options
+        self.class.cache_options
+      end
+      
+      def clear_cache
+        cache_store.delete cache_key
+      end
+      
+      protected
+      def cache_key
+        key = cache_options[:cache_key]
+        key = key.call(self) if key.is_a? Proc
+        key = self.to_json if key.nil?
+        
+        ::ActiveSupport::Cache.expand_cache_key key, :modular
+      end
+      
+      def cached?
+        cache_store.exist? cache_key
+      end
+      
+      def get_cached
+        cache_store.read cache_key
+      end
+      
+      def do_caching(data)
+        cache_store.write cache_key, data, cache_options
+      end
+
+    end
+  end
+end

data/lib/modular/components/base.rb

@@ -0,0 +1,29 @@
+require 'abstract_controller'
+require "modular/abstract_model"
+require "modular/rendering"
+require "modular/caching"
+
+module Modular
+  module Components
+    class Base < Modular::Helpers::AbstractModel
+      #rendering
+      include AbstractController::Rendering
+      include Modular::Components::DirectRender
+      
+      #slug
+      def self.type
+        self.name.rpartition("::").last
+      end
+      
+      def type
+        self.class.type
+      end
+
+      #params for element itself
+      attr_reader_with_default :width, 300
+      attr_reader :title
+      
+      validates :title, :length => {:maximum => 64}
+    end
+  end
+end

data/lib/modular/components/container.rb

@@ -0,0 +1,39 @@
+module Modular
+  module Components
+    class Container < Base
+      include Modular::Components::IndirectRender
+      
+      attr_accessor :components
+      
+      def initialize(attributes = {})
+        @attributes = ActiveSupport::HashWithIndifferentAccess.new(:components => [])
+        attributes = attributes.with_indifferent_access
+        attributes["components"] ||= []
+
+        attributes["components"].each do |value|
+          if value.is_a? Modular::Components::Base
+            @attributes[:components].push value
+          else
+            @attributes[:components].push(Modular.from_json(value)) rescue ''
+          end
+        end
+        
+        super(attributes.except("components"))
+      end
+      
+      def add(type, args = {}, &block)
+        cont = Modular.create(type, args)
+        cont.instance_eval &block if block_given?
+        components.push cont
+      end
+      
+      # def render_child(component, render_type)
+        # if component.is_a?(Modular::Components::IndirectRender)&&(render_type == :indirect) 
+          # component.indirect_render.html_safe
+        # else
+          # ("<%= Modular.from_json('" + component.to_json.html_safe + "').render %>").html_safe
+        # end
+      # end
+    end
+  end
+end

data/lib/modular/components/main_content.rb

@@ -0,0 +1,9 @@
+class Modular::Components::MainContent < Modular::Components::Base
+  include Modular::Components::IndirectRender
+  
+  def indirect_render(args = {})
+    '<%=yield%>'.html_safe
+  end
+end
+
+MainContent = Modular::Components::MainContent 

data/lib/modular/configuration.rb

@@ -0,0 +1,31 @@
+module Modular
+  class Configuration
+    attr_accessor_with_default :columns, 12
+    attr_accessor_with_default :column_width, 68
+    attr_accessor_with_default :padding_width, 15
+    attr_reader :layouts
+    
+    def self.config
+      @@config ||= new
+    end
+  
+    def self.configure(&block)
+      @@config = new
+      @@config.instance_eval &block if block_given?
+      @@config
+    end
+    
+    def register_layout(layout, mod = :Container, params = {}, &block)
+      @layouts ||= {}.with_indifferent_access
+      
+      if mod.is_a? Components::Base
+        @layouts[layout.to_s] = mod
+      else
+        root_layout = Modular.create mod, params
+        root_layout.instance_eval &block if block_given?
+        @layouts[layout.to_s] = root_layout
+      end
+    end
+    
+  end
+end

data/lib/modular/layout_generator.rb

@@ -0,0 +1,66 @@
+require 'erb'
+
+module Modular
+  class LayoutGenerator
+    class ERBContext
+      def initialize(hash)
+        hash.each_pair do |key, value|
+          instance_variable_set('@' + key.to_s, value)
+        end
+      end
+    
+      def get_binding
+        binding
+      end
+    end
+    
+    def self.generate(id, params = {})
+      new(id, params).generate
+    end
+    
+    def generate
+      write_layout unless layout_exists?
+      filename.to_s
+    end
+
+    def initialize(id, params)
+      @id = id
+      @params = params
+    end
+
+    protected
+    def foldername
+      'tmp/modular/'
+    end
+      
+    def filename
+      foldername + (@id.to_s + (@params[:cache_key].to_s) + '.html.erb')
+    end
+    
+    def layout_exists?
+      if (defined? Rails) && (Rails.configuration.action_controller.perform_caching)
+        File.exists?(filename)
+      else
+        false
+      end
+    end
+    
+    def write_layout
+      folder = self.foldername
+      filename = self.filename
+      
+      Dir.mkdir(folder) unless File.exists? folder
+      
+      template = ERB.new File.new(Gem.loaded_specs['modular'].full_gem_path + '/templates/layout.erb').read
+      output = template.result(ERBContext.new(template_variables).get_binding)
+      
+      File.open(filename, 'w') do |f| 
+        f.write(output)
+      end
+    end
+    
+    def template_variables
+      @params.merge :layout_id => @id
+    end
+  end
+end

data/lib/modular/rails.rb

@@ -0,0 +1,16 @@
+require 'action_controller'
+
+class ActionController::Base
+  def render_modular_layout(name)
+    layout = Modular.layout name
+    render :text => layout.render
+  end
+
+  def self.modular_layout(name, params = {})
+    proc = Proc.new do |controller|
+      '../../../' + Modular.generate_rails_layout(name.is_a?(Symbol) ? controller.__send__(name) : name, params)
+    end
+    
+    layout proc
+  end
+end

data/lib/modular/rendering.rb

@@ -0,0 +1,72 @@
+module Modular
+  module Components
+    module DirectRender
+      extend ActiveSupport::Concern
+      
+      module InstanceMethods
+  
+        def controller_path
+          'components'
+        end
+        
+        def action_name
+          type.underscore
+        end
+        
+        def execute
+        end
+  
+        def render
+          execute
+          modular_render :render_type => :direct
+        end
+        
+        def initialize(attributes = {})
+          append_view_path File.join('app', 'views')
+          super
+        end
+        
+        protected 
+        def modular_render(args = {})
+          render_to_string :file => 'components/' + action_name, :locals => args
+        end
+      end
+      
+      
+      module ClassMethods
+        def view_context_class
+          context = super
+          
+          context.send :define_method, :render_component do |component|
+            if component.is_a?(Modular::Components::IndirectRender)
+              component.indirect_render
+            else
+               a = "<%= Modular.from_json('"+ component.to_json + "').render %>"
+               a.html_safe
+            end
+          end
+          context
+        end
+      end
+
+    end
+
+    module IndirectRender
+      def execute
+      end
+      
+      def indirect_render
+        execute
+        modular_render :render_type => :indirect
+      end
+
+      def render(args = {})
+        throw "Direct render unavailible for this component"
+      end
+      
+      def self.included(base)
+        thow "Unable to use indirect render without direct render" unless base.ancestors.include? Modular::Components::DirectRender
+      end
+    end
+  end
+end

data/lib/modular/version.rb

@@ -0,0 +1,3 @@
+module Modular
+  VERSION = "0.1"
+end

data/lib/modular.rb

@@ -0,0 +1,57 @@
+require "active_support/all"
+
+module Modular
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :Configuration
+    autoload :LayoutGenerator
+  end
+  
+  def create(typ, params = {})
+    return typ if typ.is_a? Components::Base
+    
+    begin
+      begin
+        component = typ.to_s.camelize.constantize.new params
+      rescue NameError
+        component = (Components.name + '::' + typ.to_s.camelize).constantize.new params
+      end
+    rescue Exception => e
+      raise "Unable to create element " + typ.to_s
+    end
+    
+    raise "Component has errors: " + component.errors.to_s unless component.valid?
+    
+    component
+  end
+  
+  def from_json(text)
+    obj = ActiveSupport::JSON.decode text
+    raise "Type expected in json string" unless obj['type']
+    create(obj['type'], obj.except('type'))
+  end
+  
+  delegate :config, :configure, :to => Configuration
+  
+  def layout(id)
+    Configuration.config.layouts[id]
+  end
+  
+  def layouts
+    Configuration.config.layouts.keys
+  end
+  
+  def generate_rails_layout(id, params = {})
+    LayoutGenerator.generate(id, params)
+  end
+  
+  extend self
+end
+
+require "modular/components/base"
+require "modular/components/container"
+require "modular/components/main_content"
+require "modular/version"
+
+require "modular/rails" if defined? Rails

data/modular-app/Gemfile

@@ -0,0 +1,20 @@
+source 'http://rubygems.org'
+
+gem 'rails'
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+gem 'mongrel'
+
+gem "modular", :path => ".."
+
+group :development, :test do
+  gem 'autotest-standalone'
+  gem 'autotest-rails-pure'
+
+  gem 'rspec-rails', '~> 2.5.0'
+  gem 'ruby-debug'
+  gem 'webrat'
+  
+  gem 'autotest-growl', :require => false
+end

data/modular-app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+ModularApp::Application.load_tasks

data/modular-app/app/components/cached_for_time.rb

@@ -0,0 +1,10 @@
+class Modular::Components::CachedForTime < Modular::Components::Base
+  include Modular::Components::Caching
+  cache :expires_in => 2.seconds
+  
+  def execute
+    SimpleModel.called_by_cached_for_time
+  end
+end
+
+CachedForTime = Modular::Components::CachedForTime 

data/modular-app/app/components/cached_forever.rb

@@ -0,0 +1,10 @@
+class Modular::Components::CachedForever < Modular::Components::Base
+  include Modular::Components::Caching
+  cache
+  
+  def execute
+    SimpleModel.called_by_cached_forever
+  end
+end
+
+CachedForever = Modular::Components::CachedForever 

data/modular-app/app/components/fake_news_feed.rb

@@ -0,0 +1,9 @@
+module Modular
+  module Components
+    class FakeNewsFeed < Modular::Components::Base
+      attr_reader :news_count
+    end
+  end
+end
+
+FakeNewsFeed = Modular::Components::FakeNewsFeed

data/modular-app/app/components/foobar.rb

@@ -0,0 +1,7 @@
+class Foobar < Modular::Components::Base
+  attr_reader :text
+  
+  def execute
+    SimpleModel.foobar_method
+  end
+end

data/modular-app/app/components/heavy_task.rb

@@ -0,0 +1,5 @@
+class Modular::Components::HeavyTask < Modular::Components::Base
+  include Modular::Components::IndirectRender
+end
+
+HeavyTask = Modular::Components::HeavyTask 

data/modular-app/app/components/validated.rb

@@ -0,0 +1,10 @@
+class Modular::Components::Validated < Modular::Components::Base
+  attr_reader :non_existant_property
+  
+  validates_presence_of :non_existant_property
+  
+  def execute
+  end
+end
+
+Validated = Modular::Components::Validated

data/modular-app/app/components/vertical.rb

@@ -0,0 +1,4 @@
+class Modular::Components::Vertical < Modular::Components::Base
+end
+
+Vertical = Modular::Components::Vertical 

data/modular-app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/modular-app/app/controllers/cached_for_time_controller.rb

@@ -0,0 +1,7 @@
+class CachedForTimeController < ApplicationController
+  modular_layout 'cached_for_time'
+  
+  def index
+  end
+
+end

data/modular-app/app/controllers/cached_forever_controller.rb

@@ -0,0 +1,6 @@
+class CachedForeverController < ApplicationController
+  modular_layout 'cached_forever'
+  
+  def index
+  end
+end

data/modular-app/app/controllers/callback_layout_controller.rb

@@ -0,0 +1,11 @@
+class CallbackLayoutController < ApplicationController
+  modular_layout :method_name
+  
+  def method_name
+    'heavy'
+  end
+  
+  def index
+  end
+
+end

data/modular-app/app/controllers/example_controller.rb

@@ -0,0 +1,5 @@
+class ExampleController < ApplicationController
+  def index
+    render_modular_layout :simple
+  end
+end