seiten 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5731f8e378e32e46014e4d2f9d2748eae3803569
+  data.tar.gz: 39292b7f8b3ed0420519f81d562c2ec0c1c878a6
+SHA512:
+  metadata.gz: 077a595d5009743cba67dc635509d57000bc1858ee9194c9ffda5dbad5b01bd92105d96c57afcc3c14b60bc8c8348024b82d74076d17b1f9ca0e1c213a2f327e
+  data.tar.gz: 2dca4f322b805da90386ac74e71a7b224759c08a524d8e9f45cd60348c16465cf2d6a3a5bb04277337ea068c8422ee0259bd4e13ad28705b3a6fc246db0afa3c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Daniel Puglisi
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Seiten'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/seiten/pages_controller.rb

@@ -0,0 +1,12 @@
+module Seiten
+  class PagesController < ::ApplicationController
+
+    def show
+      if current_page.nil?
+        head :not_found
+      else
+        @title = current_page.title
+      end
+    end
+  end
+end

data/app/helpers/seiten_helper.rb

@@ -0,0 +1,38 @@
+module SeitenHelper
+
+  def render_html
+    if params[:page]
+      filename = params[:page]
+    else
+      filename = "home"
+    end
+    render :file => File.join(Rails.root, Seiten.config[:storage_directory], filename)
+  end
+
+  def seiten_navigation(parent_id=nil, deep=2)
+    output ||= ""
+
+    if deep > 0
+      Seiten::Page.find_by_parent_id(parent_id).each do |page|
+        status = page.active?(current_page) ? "active" : "inactive"
+        output += "<li class='#{status}'>#{link_to(page.title, page.slug)}"
+        unless page.children.blank?
+          output += seiten_navigation(page.id, deep-1)
+        end
+        output += "</li>"
+      end
+    end
+    raw "<ul>#{output}</ul>"
+  end
+
+  def seiten_breadcrumb
+    output = content_tag(:ul, class: "breadcrumb") do
+      Seiten::Page.get_breadcrumb(current_page).reverse.collect { |page|
+        content_tag :li do
+          raw "> #{link_to(page.title, page.slug)}"
+        end
+      }.join().html_safe
+    end
+    output
+  end
+end

data/app/views/seiten/pages/show.html.erb

@@ -0,0 +1 @@
+<%= render_html %>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+
+  # Redirects
+  Seiten::Page.all.each do |page|
+    if page.redirect
+      get page.slug => redirect(page.children.first.slug)
+    end
+  end
+
+  get "/*page" => "seiten/pages#show", as: :seiten_page
+end

data/lib/seiten/controllers/helpers.rb

@@ -0,0 +1,11 @@
+module Seiten
+  module Controllers
+    # Those helpers are convenience methods added to ApplicationController.
+    module Helpers
+
+      def current_page
+        @current_page ||= Seiten::Page.find_by_slug(request.fullpath)
+      end
+    end
+  end
+end

data/lib/seiten/engine.rb

@@ -0,0 +1,4 @@
+module Seiten
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/seiten/page.rb

@@ -0,0 +1,79 @@
+module Seiten
+
+  class Page
+
+    attr_accessor :id, :parent_id, :title, :children, :slug, :redirect
+
+    # initialize Page object with attributes
+    def initialize(options={})
+      @id        = options[:id]
+      @parent_id = options[:parent_id]
+      @title     = options[:title]
+      @slug      = options[:slug]
+      @redirect  = options[:redirect]
+    end
+
+    def self.all
+      page_store = PageStore.new
+      page_store.load_pages
+    end
+
+    # find page by id
+    def self.find(id)
+      Page.all.select { |page| page.id == id }.first
+    end
+
+    # find all pages by parent_id
+    def self.find_by_parent_id(parent_id)
+      Page.all.select { |page| page.parent_id == parent_id }
+    end
+
+    # find a page by slug
+    def self.find_by_slug(slug)
+      Page.all.select { |page| page.slug == slug }.first
+    end
+
+    # get breadcrumb of given page (reversed)
+    def self.get_breadcrumb(page)
+      pages ||= []
+      pages << page
+      if page.parent
+        pages << Page.get_breadcrumb(page.parent)
+      end
+      pages.flatten
+    end
+
+    # get parent of page
+    def parent
+      Page.find(parent_id)
+    end
+
+    # get children of page
+    def children
+      Page.all.select { |page| page.parent_id == id }
+    end
+
+    # true if child is children of page
+    def parent_of?(child)
+      page = self
+      if child
+        if page.id == child.parent_id
+          true
+        else
+          child.parent.nil? ? false : page.parent_of?(child.parent)
+        end
+      end
+    end
+
+    # true if page is equal current_page or parent of current_page
+    def active?(current_page)
+      if id == current_page.id
+        true
+      elsif parent_of?(current_page)
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/seiten/page_store.rb

@@ -0,0 +1,58 @@
+module Seiten
+
+  class PageStore
+
+    attr_accessor :storage_type, :storage_file, :storage_directory
+
+    def initialize(options={})
+      @storage_type      = options[:storage_type]
+      @storage_file      = options[:storage_file]
+      @storage_directory = options[:storage_directory]
+
+      @storage_type ||= Seiten.config[:storage_type]
+      @storage_file ||= File.join(Rails.root, Seiten.config[:storage_file])
+    end
+
+    def load_pages(options={})
+
+      pages  = options[:pages]
+      parent_id = options[:parent_id]
+      url       = options[:url]
+
+      # Setting default values
+      if storage_type == :yaml
+        pages ||= YAML.load_file(storage_file)
+      end
+      parent_id   ||= nil
+      url         ||= ""
+      @id         ||= 1
+      @navigation ||= []
+
+      pages.each_index do |i|
+
+        page = pages[i]
+        page["id"] = @id
+        page["parent_id"] = parent_id
+        @id += 1
+
+        # Build link
+        slug = page["url"].nil? ? page["title"].parameterize : page["url"]
+        if slug[0] == "/" || !!(slug.match(/^http:\/\/.+/))
+          page["slug"] = slug
+        else
+          page["slug"] = "#{url}/#{slug}"
+        end
+
+        if page["nodes"]
+          load_pages(pages: page["nodes"], parent_id: page["id"], url: page["slug"])
+        end
+
+        page.delete("nodes")
+        page_params = page.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+        @navigation << Page.new(page_params)
+      end
+
+      @navigation
+    end
+  end
+end

data/lib/seiten/version.rb

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

data/lib/seiten.rb

@@ -0,0 +1,25 @@
+require 'seiten/engine'
+require 'seiten/page_store'
+require 'seiten/page'
+
+module Seiten
+
+  @config = {
+    storage_type: :yaml,
+    storage_file: File.join('config', 'navigation.yml'),
+    storage_directory: File.join('app', 'pages')
+  }
+
+  def self.config
+    @config
+  end
+
+  module Controllers
+    autoload :Helpers, 'seiten/controllers/helpers'
+  end
+
+  ActiveSupport.on_load(:action_controller) do
+    include Controllers::Helpers
+    helper_method :current_page
+  end
+end

data/lib/tasks/sticky_pages_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sticky_pages do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

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

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/pages/home.html.erb

@@ -0,0 +1 @@
+Test

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%# <%= javascript_include_tag "application" %1> %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= seiten_navigation %>
+
+<%= yield %>
+
+</body>
+</html>