page_fragments 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexandr Promakh
+
+MIT License
+
+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.md

@@ -0,0 +1,54 @@
+# PageFragments
+
+Page Fragments is gem for Ruby On Rails.
+PageFragments allow you to store snippets of pages in the database and edit them in the admin application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "page_fragments"
+
+First, execute
+
+    $ rails generate page_fragments:install
+
+this create config/page_fragments.rb when you write you templates
+
+```ruby
+PageFragment.templates do
+  #fragment :fragment_type, :fragment_key
+
+  fragment :string, :header
+  fragment :text, :about
+end
+```
+
+After edit templates config you should execute 'rake pf:init'. This create templates in your database.
+
+And this generator create migration for PageFragment model.
+Now we have to perform
+
+    $ rake db:migrate
+
+PageFragments have standard controller and views. You can using own controller inherited from `PageFragments::PageFragmentsController`.
+After this you should to edit routes.
+
+It will copy all views to your application:
+
+    $ rails generate page_fragments:views
+
+## Usage
+
+In you view:
+
+```erb
+<%= render_page_fragment :key_of_fragment %>
+```
+
+## Authors
+
+Promakh Alexandr: s-promakh@ya.ru
+MyStand: http://mystand.ru/
+
+MIT License. Copyright 2013 Promakh Alexandr.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/page_fragments/page_fragments_controller.rb

@@ -0,0 +1,21 @@
+module PageFragments
+  class PageFragmentsController < ApplicationController
+
+    def index
+      @page_fragments = PageFragment.all
+    end
+
+    def edit
+      @page_fragment = PageFragment.find(params[:id])
+    end
+
+    def update
+      @page_fragment = PageFragment.find(params[:id])
+      if @page_fragment.update_attributes(params[:page_fragment])
+        redirect_to :action => :index
+      else
+        render :edit
+      end
+    end
+  end
+end

data/app/helpers/page_fragments/page_fragment_helper.rb

@@ -0,0 +1,8 @@
+module PageFragments
+  module PageFragmentHelper
+    def render_page_fragment *keys
+      pf = keys.first.is_a?(PageFragments::PageFragment) ? keys.first : PageFragments::PageFragment.get(keys.flatten)
+      pf && pf.content.to_s.html_safe
+    end
+  end
+end

data/app/models/page_fragments/page_fragment.rb

@@ -0,0 +1,123 @@
+module PageFragments
+  class PageFragment < ActiveRecord::Base
+    default_scope where(:hidden => false) if self.column_names.include?('hidden')
+    attr_accessible :key, :content
+
+    KEY_REGEXP = /^[a-z_.]+$/
+    AVAILABLE_CONTENT_TYPES = [:text, :string, :integer]
+
+    before_save :validate
+
+    validates :key, :uniqueness => true, :presence => true, :format => {:with => KEY_REGEXP}
+
+    serialize :validation, Hash
+
+    def self.config &block
+      if PageFragment.table_exists?
+        if PageFragment.column_names.include?('hidden')
+          PageFragment.all.each { |pf| pf.hidden = true; pf.save(:validate => false) }
+        end
+        PageFragment::Configuring.instance_eval(&block)
+      end
+    end
+
+    def self.get *keys
+      key = PageFragment.parse_key keys.flatten
+      PageFragment.where(:key => key).first || raise(ActiveRecord::RecordNotFound)
+    end
+
+    def self.set keys, value
+      item = PageFragment.get(keys)
+      item.content = value
+      item.save
+      item
+    end
+
+    def to_s
+      I18n.t("page_fragments.#{self.key}.name")
+    end
+
+    def parents
+      names = []
+      self.keys.each { |k| names << [names.last, k].join(".") }
+      names
+    end
+
+    def short_name
+      I18n.t("page_fragments.#{self.key}.name")
+    end
+
+    def keys
+      (self.key || "").split(".")
+    end
+
+    def nesting_level
+      self.keys.size
+    end
+
+    def type? target
+      if target.is_a? Array
+        target.map { |t| t.to_s }.include?(self.content_type)
+      else
+        self.content_type == target.to_s
+      end
+    end
+
+    private
+
+    def self.parse_key *keys
+      keys.flatten.map { |k| k.to_s }.join(".") #its for i18n
+    end
+
+    def validate
+      return if self.new_record?
+      self.validation.each do |name, options|
+        case options
+          when TrueClass
+            options = {}
+          when Hash
+            options
+          when Range, Array
+            options = {:in => options}
+          else
+            options = {:with => options}
+        end
+        options[:attributes] = [:content]
+        begin
+          validator_name = (name.to_s.camelize + "Validator")
+          validator_class = ("ActiveModel::Validations::" + validator_name).constantize
+        rescue
+          raise "can't find validator #{validator_name}"
+        end
+        validator = validator_class.new(options)
+        validator.validate(self)
+      end
+      self.errors.empty?
+    end
+
+
+    module Configuring
+      #def self.validates options, &block
+      #  PageFragment::Configuring.instance_eval(&block)
+      #end
+
+      def self.fragment *args
+        type = args.delete(args.first)
+        params = args.last.is_a?(Hash) ? args.delete(args.last) : {}
+        keys = args.flatten
+        PageFragment::Configuring.init type, keys, params
+      end
+
+      def self.init type, keys, validation
+        key = PageFragment.parse_key keys.flatten
+        item = PageFragment.unscoped.where(:key => key).first || PageFragment.new(:key => key)
+        raise "unexpected type of fragment" unless AVAILABLE_CONTENT_TYPES.include? type
+        item.content_type = type.to_s
+        item.validation = validation
+        item.hidden = false if PageFragment.column_names.include?('hidden')
+        item.save
+      end
+    end
+  end
+end
+

data/app/views/page_fragments/page_fragments/edit.html.haml

@@ -0,0 +1,11 @@
+= form_for @page_fragment, :as => :page_fragment, :url => url_for(:action => :update, :id => @page_fragment.id) do |f|
+  %fieldset
+    %legend= @page_fragment.short_name
+
+    %div
+      = f.label :content
+      %br
+      = f.text_area :content
+
+    = f.submit "Save"
+    = link_to "Cancel", url_for(:action => :index)

data/app/views/page_fragments/page_fragments/index.html.haml

@@ -0,0 +1,11 @@
+.page-fragments
+  %h2="Page Fragments"
+  %table
+    %thead
+      %th= "Name"
+      %th
+    - @page_fragments.each do |page_fragment|
+      %tr
+        %td= page_fragment.short_name
+        %td
+          = link_to "Edit", url_for(:action => :edit, :id => page_fragment.id)

data/config/routes.rb

@@ -0,0 +1,4 @@
+#Rails.application.routes.draw do
+  #resources :page_fragments, :only => [:index, :edit, :destroy], :controller => "page_fragments/page_fragments"
+  #match :hello, :to => "page_fragments/page_fragments#index"
+#end

data/lib/generators/page_fragments/install_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators/active_record'
+require 'rails/generators/migration'
+
+module PageFragments
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_templates
+        copy_file "templates.rb", "config/page_fragments.rb"
+      end
+
+      #def copy_locales
+      #  copy_file "page_fragments.en.yml", "config/locales/page_fragments.en.yml"
+      #end
+
+      #def copy_initialize
+      #  template "initialize.rb", "config/initializers/page_fragments.rb"
+      #end
+
+      def insert_route
+        route 'resources :page_fragments, :only => [:index, :edit, :update, :destroy], :controller => "page_fragments/page_fragments"'
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_page_fragments.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/page_fragments/templates/initialize.rb

@@ -0,0 +1,5 @@
+PageFragment.setup do |config|
+  #config.controller = :page_fragments
+  #config.model = :page_fragment
+
+end

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

@@ -0,0 +1,13 @@
+class CreatePageFragments < ActiveRecord::Migration
+  def change
+    create_table :page_fragments do |t|
+      t.string :key
+      t.string :content_type
+      t.text :validation
+      t.text :content
+      t.boolean :hidden, :default => false
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/page_fragments/templates/page_fragments.en.yml

@@ -0,0 +1,6 @@
+en:
+  views:
+    page_fragments:
+      page_fragments:
+        index:
+          title: Page fragments

data/lib/generators/page_fragments/templates/templates.rb

@@ -0,0 +1,3 @@
+PageFragments.templates do
+  #fragment :fragment_type, :fragment_key
+end

data/lib/generators/page_fragments/views_generator.rb

@@ -0,0 +1,17 @@
+module PageFragments
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root = File.join(File.dirname(__FILE__), '../../../app/views/page_fragments/page_fragments')
+      end
+
+      def copy_vies
+        copy_file "index.html.haml", "app/views/page_fragments/page_fragments/index.html.haml"
+        copy_file "edit.html.haml", "app/views/page_fragments/page_fragments/edit.html.haml"
+      end
+
+    end
+  end
+end

data/lib/page_fragments.rb

@@ -0,0 +1,22 @@
+require "rails"
+require "page_fragments/version"
+
+module PageFragments
+  #def self.config
+  #  yield self
+  #end
+
+  def self.templates &block
+    self::PageFragment.config &block
+  end
+
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.join(File.dirname(__FILE__), 'tasks/pf.rake')
+    end
+  end
+
+  class Engine < Rails::Engine
+  end
+
+end

data/lib/page_fragments/routes.rb

@@ -0,0 +1,50 @@
+module ActionDispatch::Routing
+  class Mapper
+    def devise_for(*resources)
+      options = resources.extract_options!
+
+      options[:as]          ||= @scope[:as]     if @scope[:as].present?
+      options[:module]      ||= @scope[:module] if @scope[:module].present?
+      options[:path_prefix] ||= @scope[:path]   if @scope[:path].present?
+      options[:path_names]    = (@scope[:path_names] || {}).merge(options[:path_names] || {})
+      options[:constraints]   = (@scope[:constraints] || {}).merge(options[:constraints] || {})
+      options[:defaults]      = (@scope[:defaults] || {}).merge(options[:defaults] || {})
+      options[:options]       = @scope[:options] || {}
+      options[:options][:format] = false if options[:format] == false
+
+      resources.map!(&:to_sym)
+
+      resources.each do |resource|
+        mapping = Devise.add_mapping(resource, options)
+
+        begin
+          raise_no_devise_method_error!(mapping.class_name) unless mapping.to.respond_to?(:devise)
+        rescue NameError => e
+          raise unless mapping.class_name == resource.to_s.classify
+          warn "[WARNING] You provided devise_for #{resource.inspect} but there is " <<
+                   "no model #{mapping.class_name} defined in your application"
+          next
+        rescue NoMethodError => e
+          raise unless e.message.include?("undefined method `devise'")
+          raise_no_devise_method_error!(mapping.class_name)
+        end
+
+        routes  = mapping.used_routes
+
+        devise_scope mapping.name do
+          if block_given?
+            ActiveSupport::Deprecation.warn "Passing a block to devise_for is deprecated. " \
+              "Please remove the block from devise_for (only the block, the call to " \
+              "devise_for must still exist) and call devise_scope :#{mapping.name} do ... end " \
+              "with the block instead", caller
+            yield
+          end
+
+          with_devise_exclusive_scope mapping.fullpath, mapping.name, options do
+            routes.each { |mod| send("devise_#{mod}", mapping, mapping.controllers) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/page_fragments/version.rb

@@ -0,0 +1,3 @@
+module PageFragments
+  VERSION = "0.0.1"
+end

data/lib/tasks/pf.rake

@@ -0,0 +1,5 @@
+namespace :pf do
+  task :init => :environment do
+    require File.join(Rails.root, "config", "page_fragments")
+  end
+end

data/page_fragments.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'page_fragments/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "page_fragments"
+  gem.version       = PageFragments::VERSION
+  gem.authors       = ["Alexandr Promakh"]
+  gem.email         = ["s-promakh@ya.ru"]
+  gem.description   = %q{ Storage page fragments in database }
+  gem.summary       = gem.description
+  gem.homepage      = "http://mystand.ru/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9.2"
+
+  gem.license       = "MIT"
+
+  gem.add_dependency "haml", "~> 4.0.3"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: page_fragments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexandr Promakh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+description: ! ' Storage page fragments in database '
+email:
+- s-promakh@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/page_fragments/page_fragments_controller.rb
+- app/helpers/page_fragments/page_fragment_helper.rb
+- app/models/page_fragments/page_fragment.rb
+- app/views/page_fragments/page_fragments/edit.html.haml
+- app/views/page_fragments/page_fragments/index.html.haml
+- config/routes.rb
+- lib/generators/page_fragments/install_generator.rb
+- lib/generators/page_fragments/templates/initialize.rb
+- lib/generators/page_fragments/templates/migration.rb
+- lib/generators/page_fragments/templates/page_fragments.en.yml
+- lib/generators/page_fragments/templates/templates.rb
+- lib/generators/page_fragments/views_generator.rb
+- lib/page_fragments.rb
+- lib/page_fragments/routes.rb
+- lib/page_fragments/version.rb
+- lib/tasks/pf.rake
+- page_fragments.gemspec
+homepage: http://mystand.ru/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Storage page fragments in database
+test_files: []