ixtlan-core 0.1.0

data/README.textile

@@ -0,0 +1,31 @@
+h1. Ixtlan
+
+p. this project is just a compilation of things I am doing all over the place in my projects. there is a focus on privacy protection which needs a strong security in the first place.
+
+p. this gem is quite invasive in terms of default templates of rails3. first it adds json serializers and looks for a lot of switches from other gems like 'ixtlan-audit', 'ixtlan-session-timeout', 'ixtlan-error-handler', 'rails-resty-generators', etc
+
+h2. setup generator
+
+p. this just adds an preinitializer to the rails application which allows to keep the config/database.yml almost as is and allows to put the passwords for the production database into a 'production.yml' - just ignore that production.yml from git and keep it only on the deployed server. same you can do for an external mail provider.
+
+p. further if you can configure a configuration (singleton) model which allows to register components which can notified when a configuration changes.
+
+p. since the model generator also needs to work nice with rails-resty-generators it add beside the "reference/belongs_to" also a "has_one" and "has_many" types. this allows to generate the ruby models along with java GWT models in a similar manner (note: restrictions and short comings are there . . .).
+
+h2. cache headers
+
+p. that is the only "real" feature of the ixtlan-core gem. with this you can control the cache header with three predefined modi:
+
+* private: no caching of data for any proxy or browser
+
+* protected: only browser can cache
+
+* public: proxies and browsers can cache as desired
+
+of any sensitive data go for the private mode.
+
+p. this control is only active when there is logged in user, i.e. controller.current_user != null. also when the controller does not set the cache-header the rails default is used.
+
+h3. credits
+
+p. the cache header uses http://code.google.com/p/doctype/wiki/ArticleHttpCaching as specification

data/features/generators.feature

@@ -0,0 +1,5 @@
+Feature: Generators for Ixtlan Audit
+
+  Scenario: The slf4r rails template creates a rails application which uses slf4r-wrapper
+    Given I create new rails application with template "simple.template"
+    Then the output should contain "setup slf4r logger wrapper with ActiveSupport::BufferedLogger"

data/features/step_definitions/simple_steps.rb

@@ -0,0 +1,22 @@
+require 'fileutils'
+Given /^I create new rails application with template "(.*)"$/ do |template|
+  name = template.sub(/.template$/, '')
+  directory = File.join('target', name)
+  rails_version = ENV['RAILS_VERSION'] || '3.0.1'
+
+  ruby = defined?(JRUBY_VERSION) ? "jruby" : "ruby"
+  rails_command = "#{ENV['GEM_HOME']}/bin/rails"
+  rails_command = "-S rails" unless File.exists?(rails_command)
+  command = "#{rails_command} _#{rails_version}_ new #{directory} -f -m templates/#{template}"
+  FileUtils.rm_rf(directory)
+
+  system "#{ruby} #{command}"
+  
+  @result = File.read("target/#{name}/log/development.log")
+  puts @result
+end
+
+Then /^the output should contain \"(.*)\"$/ do |expected|
+  (@result =~ /.*#{expected}.*/).should_not be_nil
+end
+

data/lib/generators/ixtlan/base.rb

@@ -0,0 +1,45 @@
+require 'rails/generators/named_base'
+module Ixtlan
+  module Generators
+    class Base < Rails::Generators::Base
+
+      argument :name, :type => :string, :required => false
+
+      protected
+      def generator_name
+        raise "please overwrite generator_name"
+      end
+
+      public
+      def create
+        args = []
+        if name
+          args << ARGV.shift
+        else
+          args << "configuration"
+        end
+
+        if defined? ::Ixtlan::Errors
+          args << "errors_keep_dumps:integer"
+          args << "errors_dir:string"
+          args << "errors_from:string"
+          args << "errors_to:string"
+        end
+
+        if defined? ::Ixtlan::Sessions
+          args << "idle_session_timeout:integer"
+        end
+
+        if defined? ::Ixtlan::Audit
+          args << "audit_keep_log:integer"
+        end
+        
+        args += ARGV[0, 10000] || []
+        
+        args << "--singleton"
+
+        generate generator_name, *args
+      end
+    end
+  end
+end

data/lib/generators/ixtlan/configuration_model/configuration_model_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/ixtlan/base'
+module Ixtlan
+  module Generators
+    class ConfigurationModelGenerator < Base
+
+      protected
+      def generator_name
+        "model"
+      end
+    end
+  end
+end

data/lib/generators/ixtlan/configuration_scaffold/configuration_scaffold_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/ixtlan/base'
+module Ixtlan
+  module Generators
+    class ConfigurationScaffoldGenerator < Base
+      
+      protected
+      def generator_name
+        "scaffold"
+      end
+    end
+  end
+end

data/lib/generators/ixtlan/setup/setup_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators/base'
+module Ixtlan
+  module Generators
+    class SetupGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_preinitializer_files
+        template 'preinitializer.rb', File.join('config', "preinitializer.rb")
+        template 'gitignore', File.join('config', ".gitignore")
+        template 'production.yml.example', File.join('config', "production.yml.example")
+        template 'database.yml.example', File.join('config', "database.yml.example")
+      end
+      
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', "initializers", "ixtlan.rb")
+      end
+    
+      # TODO make only if template-engine is ERB
+      def error_templates
+        if defined? Ixtlan::Errors
+          views_dir = File.join('app', 'views', 'errors')
+          ['error', 'error_with_session', 'stale'].each do |f|
+            file = "#{f}.html.erb"
+            template file, File.join(views_dir, file)
+          end
+        end
+      end
+
+      def create_application_layout_file
+        if defined? Ixtlan::Sessions
+          layout = File.join('app', 'views', 'layouts', 'application.html.erb')
+          template 'application_layout.html.erb', layout
+        end
+      end
+    end
+  end
+end

data/lib/generators/ixtlan/setup/templates/application_layout.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Schedules</title>
+  <%%= stylesheet_link_tag :all %>
+  <%%= javascript_include_tag :defaults %>
+  <%%= csrf_meta_tag %>
+  <%% if controller.respond_to?(:current_user) && controller.send(:current_user) != nil %>
+  <meta "http-equiv"="refresh" content="#{Configuration.instance.idle_session_timeout * 60}" />
+  <%% end %>
+</head>
+<body>
+
+<%%= yield %>
+
+</body>
+</html>

data/lib/generators/ixtlan/setup/templates/database.yml.example

@@ -0,0 +1,48 @@
+# MySQL.  Versions 4.1 and 5.0 are recommended.
+#
+# Install the MySQL driver:
+#   gem install mysql
+# On Mac OS X:
+#   sudo gem install mysql -- --with-mysql-dir=/usr/local/mysql
+# On Mac OS X Leopard:
+#   sudo env ARCHFLAGS="-arch i386" gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
+#       This sets the ARCHFLAGS environment variable to your native architecture
+# On Windows:
+#   gem install mysql
+#       Choose the win32 build.
+#       Install MySQL and put its /bin directory on your path.
+#
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+development:
+  adapter: mysql
+  encoding: utf8
+  reconnect: false
+  database: test_development
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: mysql
+  encoding: utf8
+  reconnect: false
+  database: test_test
+  pool: 5
+  username: root
+  password:
+  socket: /var/run/mysqld/mysqld.sock
+
+production:
+  adapter: mysql
+  encoding: utf8
+  reconnect: false
+  database: CONFIG[:db][:database]
+  pool: 5
+  username: CONFIG[:db][:username]
+  password: CONFIG[:db][:password]
+  socket: /var/run/mysqld/mysqld.sock

data/lib/generators/ixtlan/setup/templates/error.html.erb

@@ -0,0 +1 @@
+<h1><%%= @notice %></h1>

data/lib/generators/ixtlan/setup/templates/error_with_session.html.erb

@@ -0,0 +1 @@
+<h1><%%= @notice %></h1>

data/lib/generators/ixtlan/setup/templates/gitignore

@@ -0,0 +1,2 @@
+production.yml
+*.example

data/lib/generators/ixtlan/setup/templates/initializer.rb

@@ -0,0 +1,63 @@
+# dynamic configuration through a Configuration singleton model
+
+# configuration model
+# -------------------
+# CONFIGURATION = Configuration
+# config.configuration_model = CONFIGURATION
+<% if defined? DataMapper -%>
+# config_instance = CONFIGURATION.get(1) || CONFIGURATION.new
+<% else -%>
+# config_instance = CONFIGURATION.find(1) || CONFIGURATION.new
+<%end -%>
+
+# notification email on errors and dump directory for the system dump
+# the error dumps will be cleanup after the days to keeps dump expired
+# --------------------------------------------------------------------
+# config_instance.register("error_dumper") do |config|
+#   Rails.configuration.error_dumper.dump_dir = config.errors_dir
+#   Rails.configuration.error_dumper.email_from = config.errors_from
+#   Rails.configuration.error_dumper.email_to = config.errors_to
+#   Rails.configuration.error_dumper.keep_dumps = config.errors_keep_dumps # days
+# end
+
+# idle session timeout configuration (in minutes)
+# -----------------------------------------------
+# config_instance.register("idle_session_timeout") do |config|
+#   Rails.configuration.idle_session_timeout = config.idle_session_timeout
+# end
+
+# audit log manager
+# -----------------
+
+# config.audit_manager.model = MyAudit # default: Audit
+# config.audit_manager.username_method = :username # default: :login
+
+# config_instance.register("audit_manager") do |config|
+#   Rails.configuration.audit_manager.keep_log = config.keep_log # days
+# end
+
+# --------------------
+# static configuration
+# --------------------
+
+# error dumper
+# ------------
+# notification email on errors and dump directory for the system dump. per 
+# default there is no email notification and if email_from or email_to is
+# missing then there is no email too
+
+# config.error_dumper.dump_dir = Rails.root + "/log/errors" # default: log/errors
+# config.error_dumper.email_from = "no-reply@example.com"
+# config.error_dumper.email_to = "developer1@example.com,developer2@example.com"
+# config.error_dumper.keep_dumps = 30 # days
+# config.skip_rescue_module = true # do not include the predefined Rescue 
+
+# idle session timeout configuration
+# ----------------------------------
+# config.idle_session_timeout = 30 #minutes
+
+# audit log manager
+# -----------------
+# config.audit_manager.model = MyAudit # default: Audit
+# config.audit_manager.username_method = :username # default: :login
+# config.audit_manager.keep_log = 30 # days

data/lib/generators/ixtlan/setup/templates/preinitializer.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+require 'erb'
+module Ixtlan
+  class Configurator
+
+    def self.symbolize_keys(h)
+      result = {}
+
+      h.each do |k, v|
+        v = ' ' if v.nil?
+        if v.is_a?(Hash)
+          result[k.to_sym] = symbolize_keys(v) unless v.size == 0
+        else
+          result[k.to_sym] = v unless k.to_sym == v.to_sym
+        end
+      end
+
+      result
+    end
+
+    def self.load(file)
+      if File.exists?(file)
+        symbolize_keys(YAML::load(ERB.new(IO.read(file)).result))
+      else
+        warn "no file #{file} to load - maybe the is a #{file}.example"
+      end
+    end
+  end
+end
+
+CONFIG = Ixtlan::Configurator.load(File.join(File.dirname(__FILE__), 'production.yml')) || {}

data/lib/generators/ixtlan/setup/templates/production.yml.example

@@ -0,0 +1,8 @@
+db:
+  database: production
+  username: worker
+  password: behappy
+smtp:
+  host: mail.example.com
+  username: mailworker
+  password: secret

data/lib/generators/ixtlan/setup/templates/stale.html.erb

@@ -0,0 +1,2 @@
+<h1>stale resource</h1>
+<p>please reload resource and change it again</p>

data/lib/generators/model/model_generator.rb

@@ -0,0 +1,12 @@
+module Rails
+  module Generators
+    class ModelGenerator < NamedBase #metagenerator
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      hook_for :orm, :required => true
+
+      if defined? Resty
+        hook_for :resty, :type => :boolean, :default => true
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/_form.html.erb

@@ -0,0 +1,25 @@
+<%%= form_for(@<%= singular_table_name %><% if options[:singleton] -%>
+, :url => <%= singular_table_name %>_path, :html => { :method => :put, :class => "edit_<%= singular_table_name %>", :id => "edit_<%= singular_table_name %>"}<% end -%>
+) do |f| %>
+  <%% if @<%= singular_table_name %>.errors.any? %>
+    <div id="error_explanation">
+      <h2><%%= pluralize(@<%= singular_table_name %>.errors.count, "error") %> prohibited this <%= singular_table_name %> from being saved:</h2>
+
+      <ul>
+      <%% @<%= singular_table_name %>.errors.full_messages.each do |msg| %>
+        <li><%%= msg %></li>
+      <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+<% for attribute in attributes -%>
+  <div class="field"><!-- begin - <%= attribute.name %> -->
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </div><!-- end - <%= attribute.name %> -->
+<% end -%>
+  <div class="actions">
+    <%%= f.submit %>
+  </div>
+<%% end %>

data/lib/generators/rails/templates/edit.html.erb

@@ -0,0 +1,24 @@
+<h1>Editing <%= singular_table_name %></h1>
+
+<%%= render 'form' %>
+
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :show) %>
+<% end -%>
+<% if options[:singleton] -%>
+<%%= link_to 'Show', <%= singular_table_name %>_path %>
+<% else -%>
+<%%= link_to 'Show', @<%= singular_table_name %> %>
+<% end -%>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>
+<% unless options[:singleton] -%>
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :index) %>
+<% end -%>
+| <%%= link_to 'Back', <%= index_helper %>_path %>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>
+<% end -%>

data/lib/generators/rails/templates/index.html.erb

@@ -0,0 +1,47 @@
+<h1>Listing <%= plural_table_name %></h1>
+
+<table>
+  <tr>
+<% for attribute in attributes -%>
+    <th><%= attribute.human_name %></th>
+<% end -%>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+  <tr>
+<% for attribute in attributes -%>
+    <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :show) %>
+<% end -%>
+    <td><%%= link_to 'Show', <%= singular_table_name %> %></td>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<%% if allowed?(:<%= table_name %>, :update) %>
+<% end -%>
+    <td><%%= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>) %></td>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<%% if allowed?(:<%= table_name %>, :destroy) %>
+<% end -%>
+    <td><%%= link_to 'Destroy', <%= singular_table_name %>, :confirm => 'Are you sure?', :method => :delete %></td>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>
+  </tr>
+<%% end %>
+</table>
+
+<br />
+
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :create) %>
+<% end -%>
+<%%= link_to 'New <%= human_name %>', new_<%= singular_table_name %>_path %>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>

data/lib/generators/rails/templates/migration.rb

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% attributes.select {|attr| ![:has_one, :has_many].include?(attr.type) }.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+<% if options[:modified_by] %>
+      t.references :modified_by
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/generators/rails/templates/model.rb

@@ -0,0 +1,16 @@
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select {|attr| attr.reference? }.each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+<% attributes.select {|attr| [:has_one, :has_many].include?(attr.type) }.each do |attribute| -%>
+  <%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+<% if options[:modified_by] -%>
+  belongs_to :modified_by, :class_name => "<%= options[:user_model] %>"
+<% end -%>
+<% if options[:singleton] -%>
+  def self.instance
+    self.first || self.new
+  end
+<% end -%>
+end

data/lib/generators/rails/templates/new.html.erb

@@ -0,0 +1,11 @@
+<h1>New <%= singular_table_name %></h1>
+
+<%%= render 'form' %>
+
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :index) %>
+<% end -%>
+<%%= link_to 'Back', <%= index_helper %>_path %>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>

data/lib/generators/rails/templates/show.html.erb

@@ -0,0 +1,30 @@
+<p id="notice"><%%= notice %></p>
+
+<% for attribute in attributes -%>
+<p>
+  <b><%= attribute.human_name %>:</b>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :update) %>
+<% end -%>
+<% if options[:singleton] -%>
+<%%= link_to 'Edit', edit_<%= singular_table_name %>_path %>
+<% else -%>
+<%%= link_to 'Edit', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>) %>
+<% end -%>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>
+<% unless options[:singleton] -%>
+<% if defined? ::Ixtlan::Guard -%>
+<%% if allowed?(:<%= table_name %>, :index) %>
+<% end -%>
+ | <%%= link_to 'Back', <%= index_helper %>_path %>
+<% if defined? ::Ixtlan::Guard -%>
+<%% end %>
+<% end -%>
+<% end -%>

data/lib/generators/scaffold/scaffold_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/rails/resource/resource_generator'
+
+module Rails
+  module Generators
+    class ScaffoldGenerator < ResourceGenerator #metagenerator
+      remove_hook_for :resource_controller
+      remove_class_option :actions
+
+      class_option :singleton, :type => :boolean, :default => false
+
+      hook_for :scaffold_controller, :required => true, :in => :scaffold_controller
+      hook_for :stylesheets 
+
+      if defined? Resty
+        hook_for :resty, :type => :boolean, :default => true
+      end
+
+      def add_resource_route
+        return if options[:actions].present?
+        route_config =  class_path.collect{|namespace| "namespace :#{namespace} do " }.join(" ")
+        if options[:singleton]
+          route_config << "resource :#{file_name}"
+        else
+          route_config << "resources :#{file_name.pluralize}"
+        end
+        route_config << " end" * class_path.size
+        route route_config
+      end
+    end
+  end
+end

data/lib/generators/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,48 @@
+require 'rails/generators/resource_helpers'
+require 'rails/generators/named_base'
+
+module ScaffoldController
+  module Generators
+    class ScaffoldControllerGenerator < ::Rails::Generators::NamedBase
+      include ::Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => "Controller"
+
+      class_option :orm, :banner => "NAME", :type => :string, :required => true,
+                         :desc => "ORM to generate the controller for"
+
+      class_option :singleton, :type => :boolean, :default => false
+
+      def create_controller_files
+        if options[:singleton]
+          template 'singleton_controller.rb', File.join('app/controllers', class_path, "#{controller_file_name}_controller.rb")
+        else
+          template 'controller.rb', File.join('app/controllers', class_path, "#{controller_file_name}_controller.rb")
+        end
+      end
+      
+      hook_for :template_engine, :test_framework, :as => :scaffold, :in => :rails
+
+      # Invoke the helper using the controller name (pluralized)
+      hook_for :helper, :as => :scaffold, :in => :rails do |invoked|
+        invoke invoked, [ controller_name ]
+      end
+
+      if defined? ::Resty
+        # resty gwt controller
+        hook_for :resty, :type => :boolean, :default => true do |controller|
+          invoke controller, [class_name]
+        end
+      end
+
+      if defined? ::Ixtlan::Guard
+        # allow the ixtlan guards to be generated
+        hook_for :guard, :type => :boolean, :default => true do |controller|
+          invoke controller, [class_name]
+        end
+      end
+    end
+  end
+end

data/lib/generators/scaffold_controller/templates/controller.rb

@@ -0,0 +1,99 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  # GET <%= route_url %>
+  # GET <%= route_url %>.xml
+  # GET <%= route_url %>.json
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+
+    respond_to do |format|
+      format.html # index.html.erb 
+      format.xml  { render :xml => @<%= plural_table_name %> }
+      format.json  { render :json => @<%= plural_table_name %> }
+    end
+  end
+
+  # GET <%= route_url %>/1
+  # GET <%= route_url %>/1.xml
+  # GET <%= route_url %>/1.json
+  def show
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @<%= singular_table_name %> }
+      format.json  { render :json => @<%= singular_table_name %> }
+    end
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+
+  # POST <%= route_url %>
+  # POST <%= route_url %>.xml
+  # POST <%= route_url %>.json
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "params[:#{singular_table_name}]") %>
+<% unless options[:modified_by] -%>
+    @<%= singular_table_name %>.current_user = current_user
+<% end -%>
+
+    respond_to do |format|
+      if @<%= orm_instance.save %>
+        format.html { redirect_to(@<%= singular_table_name %>, :notice => '<%= human_name %> was successfully created.') }
+        format.xml  { render :xml => @<%= singular_table_name %>, :status => :created, :location => @<%= singular_table_name %> }
+        format.json  { render :json => @<%= singular_table_name %>, :status => :created, :location => @<%= singular_table_name %> }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+        format.json  { render :json => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT <%= route_url %>/1
+  # PUT <%= route_url %>/1.xml
+  # PUT <%= route_url %>/1.json
+  def update
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+<% if options[:modified_by] -%>
+    @<%= singular_table_name %>.current_user = current_user
+<% end -%>
+
+    respond_to do |format|
+      if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %>
+        format.html { redirect_to(@<%= singular_table_name %>, :notice => '<%= human_name %> was successfully updated.') }
+        format.xml  { render :xml => @<%= singular_table_name %> }
+        format.json  { render :json => @<%= singular_table_name %> }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+        format.json  { render :json => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  # DELETE <%= route_url %>/1.xml
+  # DELETE <%= route_url %>/1.json
+  def destroy
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+<% if options[:modified_by] -%>
+    @<%= singular_table_name %>.current_user = current_user
+<% end -%>
+
+    @<%= orm_instance.destroy %>
+
+    respond_to do |format|
+      format.html { redirect_to(<%= index_helper %>_url) }
+      format.xml  { head :ok }
+      format.json  { head :ok }
+    end
+  end
+end

data/lib/generators/scaffold_controller/templates/singleton_controller.rb

@@ -0,0 +1,43 @@
+class <%= controller_class_name %>Controller < ApplicationController
+ 
+  # GET <%= route_url %>
+  # GET <%= route_url %>.xml
+  # GET <%= route_url %>.json
+  def show
+    @<%= singular_table_name %> = <%= class_name %>.instance
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @<%= singular_table_name %> }
+      format.json  { render :json => @<%= singular_table_name %> }
+    end
+  end
+
+  # GET <%= route_url %>/edit
+  def edit
+    @<%= singular_table_name %> = <%= class_name %>.instance
+  end
+
+  # PUT <%= route_url %>
+  # PUT <%= route_url %>.xml
+  # PUT <%= route_url %>.json
+  def update
+    @<%= singular_table_name %> = <%= class_name %>.instance
+<% orm_class.find(class_name)
+   if options[:modified_by] -%>
+    @<%= singular_table_name %>.current_user = current_user
+<% end -%>
+
+    respond_to do |format|
+      if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %>
+        format.html { redirect_to(<%= singular_table_name %>_path, :notice => '<%= human_name %> was successfully updated.') }
+        format.xml  { render :xml => @<%= singular_table_name %> }
+        format.json  { render :json => @<%= singular_table_name %> }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+        format.json  { render :json => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+      end
+    end
+  end
+end

data/lib/ixtlan/core/cache_headers.rb

@@ -0,0 +1,86 @@
+module Ixtlan
+  module Core
+    module CacheHeaders
+
+      protected
+
+      # Date: <ServercurrentDate>
+      # Expires: Fri, 01 Jan 1990 00:00:00 GMT
+      # Pragma: no-cache
+      # Cache-control: no-cache, must-revalidate
+      def no_caching(no_store = true)
+        if cachable_response?
+          response.headers["Date"] = timestamp
+          response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
+          response.headers["Pragma"] = "no-cache"
+          response.headers["Cache-Control"] = "no-cache, must-revalidate" + (", no-store" if no_store).to_s
+        end
+      end
+
+      # Date: <ServercurrentDate>
+      # Expires: Fri, 01 Jan 1990 00:00:00 GMT
+      # Cache-control: private, max-age=<1dayInSeconds>
+      def only_browser_can_cache(no_store = false, max_age_in_seconds = 0)
+        if cachable_response?
+          response.headers["Date"] = timestamp
+          response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 UTC"
+          response.headers["Cache-Control"] = "private, max-age=#{max_age_in_seconds}" + (", no-store" if no_store).to_s
+        end
+      end
+
+      # Date: <ServercurrentDate>
+      # Expires: <ServerCurrentDate + 1month>
+      # Cache-control: public, max-age=<1month>
+      def allow_browser_and_proxy_to_cache(no_store = false, max_age_in_seconds = 0)
+        if cachable_response?
+          now = Time.now
+          response.headers["Date"] = timestamp(now)
+          response.headers["Expires"] = timestamp(now + max_age_in_seconds)
+          response.headers["Cache-Control"] = "public, max-age=#{max_age_in_seconds}" + (", no-store" if no_store).to_s
+        end
+      end
+
+      def cache_headers
+        if(respond_to?(:current_user) && current_user)
+          case self.class.instance_variable_get(:@mode)
+          when :private
+            no_caching(self.class.instance_variable_get(:@no_store))
+          when :protected
+            only_browser_can_cache(self.class.instance_variable_get(:@no_store))
+          when :public
+            allow_browser_and_proxy_to_cache(self.class.instance_variable_get(:@no_store))
+          end
+#        else
+#          allow_browser_and_proxy_to_cache(self.class.instance_variable_get(:@no_store))
+        end
+      end
+
+      def self.included(base)
+        base.class_eval do
+          def self.cache_headers(mode = nil, no_store = true)
+            if(mode)
+              raise "supported modi are :private, :protected and :public" unless [:private, :protected, :public].member? mode.to_sym
+              @mode = mode
+            end
+            @no_store = no_store
+          end
+          alias :render_old :render
+          def render(*args)
+            cache_headers
+            render_old(*args)
+          end
+        end
+      end
+
+      private
+      def cachable_response?
+        request.method == :get &&
+          [200, 203, 206, 300, 301].member?(response.status)
+      end
+
+      def timestamp(now = Time.now)
+        now.utc.strftime "%a, %d %b %Y %H:%M:%S %Z"
+      end
+    end
+  end
+end

data/lib/ixtlan/core/configuration_manager.rb

@@ -0,0 +1,43 @@
+module Ixtlan
+  module Core
+    module ConfigurationManager
+      
+      def self.included(model)
+        model.send :include, Slf4r::Logger
+        model.after_save :fire_on_change
+        raise "configuration class must have instance method" unless model.respond_to? :instance
+        model.class_eval do
+          class << self
+            alias :instance_old :instance
+            def instance
+              Thread.current[:ixtlan_configuration] ||= instance_old
+            end
+            def clear_instance
+              Thread.current[:ixtlan_configruation] = nil
+            end
+          end
+        end
+      end
+      
+      def register(name, &block)
+        raise "need block" unless block
+        logger.info{"register config for: #{name}"}
+        registry[name.to_sym] = block
+      end
+      
+      def fire_on_change
+        registry.each do |name, callback|
+          logger.debug{ "call #{name}" }
+          callback.call(self)
+        end
+      end              
+      
+      private
+      
+      def registry
+        @registry ||= {}
+      end
+      
+    end
+  end
+end

data/lib/ixtlan/core/configuration_rack.rb

@@ -0,0 +1,19 @@
+module Ixtlan
+  module Core
+    class ConfigurationRack
+      def initialize(app)
+        @app = app
+      end
+      
+      def call(env)
+        model = Rails.application.config.configuration_model
+        # configure all registered components with current config
+        model.instance.fire_on_change if model
+        result = @app.call(env)
+        model.clear_instance if model
+        result
+      end
+      
+    end
+  end
+end

data/lib/ixtlan/core/controllers/configuration_controller.rb

@@ -0,0 +1,48 @@
+module Ixtlan
+  module Core
+    module Controllers
+      module ConfigurationController
+        
+        # GET /configuration
+        # GET /configuration.xml
+        # GET /configuration.json
+        def show
+          @config = Rails.application.config.configuration_model.instance
+          
+          respond_to do |format|
+            format.html # index.html.erb 
+            format.xml  { render :xml => @config }
+            format.json  { render :json => @config }
+          end
+        end
+
+        # GET configuration/edit
+        def edit
+          @config = Rails.application.config.configuration_model.instance
+        end
+        
+        # PUT configuration
+        # PUT configuration.xml
+        def update
+          @config = Rails.application.config.configuration_model.instance
+          
+          if @config.respond_to? :current_user && respond_to? :current_user
+            @config.current_user = current_user
+          end
+
+          respond_to do |format|
+            if @config.update_attributes
+              format.html { redirect_to(@config, :notice => 'configuration was successfully updated.') }
+              format.xml  { render :xml => @config }
+              format.json  { render :json => @config }
+            else
+              format.html { render :action => "edit" }
+              format.xml  { render :xml => @config.errors, :status => :unprocessable_entity }
+              format.json  { render :json => @config.errors, :status => :unprocessable_entity }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ixtlan/core/railtie.rb

@@ -0,0 +1,47 @@
+require 'ixtlan/core/cache_headers'
+require 'ixtlan/core/configuration_rack'
+require 'ixtlan/core/configuration_manager'
+
+module Ixtlan
+  module Core
+    class Railtie < Rails::Railtie
+      config.generators do
+        require 'rails/generators'
+        
+        templates = File.expand_path('../../../generators/rails/templates', __FILE__)
+        
+        require 'rails/generators/erb/scaffold/scaffold_generator'
+        Erb::Generators::ScaffoldGenerator.source_paths.insert(0, templates)
+        Erb::Generators::ScaffoldGenerator.class_option :singleton, :type => :boolean, :default => false
+        Erb::Generators::ScaffoldGenerator.class_eval do
+          
+          protected
+          alias :available_views_old :available_views
+          def available_views
+            if options[:singleton]
+              %w(edit show _form)
+            else
+              available_views_old
+            end
+          end
+        end
+
+        require 'rails/generators/active_record/model/model_generator'
+        ActiveRecord::Generators::ModelGenerator.source_paths.insert(0, templates)
+        ActiveRecord::Generators::ModelGenerator.class_option :singleton, :type => :boolean, :default => false
+      end
+
+      config.before_configuration do |app|
+        app.config.class.class_eval do
+          attr_accessor :configuration_model
+          def configuration_model=(clazz)
+            clazz.send(:include, Ixtlan::Core::ConfigurationManager) #unless clazz.kind_of?(Ixtlan::Core::ConfigurationManager)
+            @configuration_model = clazz
+          end
+        end
+        ::ActionController::Base.send(:include, Ixtlan::Core::CacheHeaders)
+        app.config.middleware.use Ixtlan::Core::ConfigurationRack
+      end
+    end
+  end
+end

data/lib/ixtlan-core.rb

@@ -0,0 +1,3 @@
+if defined?(Rails)
+  require 'ixtlan/core/railtie'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: ixtlan-core
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 1
+    - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+  - mkristian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +05:30
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 3
+              - 0
+              - 1
+            version: 3.0.1
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 2
+              - 0
+              - 1
+            version: 2.0.1
+    type: :development
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: cucumber
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 9
+              - 4
+            version: 0.9.4
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - "="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 8
+              - 7
+            version: 0.8.7
+    type: :development
+    version_requirements: *id004
+description: base for some gems related to protect privacy and increase security along some other utils
+email: 
+  - m.kristian@web.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - README.textile
+  - features/step_definitions/simple_steps.rb
+  - features/generators.feature
+  - lib/ixtlan-core.rb
+  - lib/generators/model/model_generator.rb
+  - lib/generators/scaffold/scaffold_generator.rb
+  - lib/generators/ixtlan/base.rb
+  - lib/generators/ixtlan/configuration_scaffold/configuration_scaffold_generator.rb
+  - lib/generators/ixtlan/setup/setup_generator.rb
+  - lib/generators/ixtlan/setup/templates/gitignore
+  - lib/generators/ixtlan/setup/templates/error_with_session.html.erb
+  - lib/generators/ixtlan/setup/templates/production.yml.example
+  - lib/generators/ixtlan/setup/templates/preinitializer.rb
+  - lib/generators/ixtlan/setup/templates/error.html.erb
+  - lib/generators/ixtlan/setup/templates/database.yml.example
+  - lib/generators/ixtlan/setup/templates/application_layout.html.erb
+  - lib/generators/ixtlan/setup/templates/initializer.rb
+  - lib/generators/ixtlan/setup/templates/stale.html.erb
+  - lib/generators/ixtlan/configuration_model/configuration_model_generator.rb
+  - lib/generators/scaffold_controller/scaffold_controller_generator.rb
+  - lib/generators/scaffold_controller/templates/controller.rb
+  - lib/generators/scaffold_controller/templates/singleton_controller.rb
+  - lib/generators/rails/templates/index.html.erb
+  - lib/generators/rails/templates/new.html.erb
+  - lib/generators/rails/templates/model.rb
+  - lib/generators/rails/templates/show.html.erb
+  - lib/generators/rails/templates/edit.html.erb
+  - lib/generators/rails/templates/migration.rb
+  - lib/generators/rails/templates/_form.html.erb
+  - lib/ixtlan/core/railtie.rb
+  - lib/ixtlan/core/configuration_manager.rb
+  - lib/ixtlan/core/cache_headers.rb
+  - lib/ixtlan/core/configuration_rack.rb
+  - lib/ixtlan/core/controllers/configuration_controller.rb
+has_rdoc: true
+homepage: http://github.com/mkristian/ixtlan-core
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.textile
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: cache header control, dynamic configuration, and rails generator templates
+test_files: []
+