left_side 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,9 @@
 # LeftSide
 
-TODO: Write a gem description
+left_side is a small tool to render sidebar for your rails app
+
+demo
+    ![left side demo](http://blog.zlxstar.me/images/left_side_demo.png)
 
 ## Installation
 
@@ -12,13 +15,31 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install left_side
+Then create config/left_side/section.yml [example](https://github.com/zlx/left_side/blob/master/lib/left_side/section.yml)
 
 ## Usage
 
-TODO: Write usage instructions here
+1. require left-side in application.css
+
+2. add 
+   ```ruby
+   <% if content_for? :nav_left %>
+     <%= yield :nav_left %>
+   <% else %>
+     <%= render_left_side controller_name %>
+   <% end %>
+   ```
+   to your layout
+
+## TODO
+
+1. add generate command to create section: copy example to left_side/section.yml
+
+2. move css to app assets to make it modify
+
+3. use url_helper in yml file
+
+4. refactor the code
 
 ## Contributing
 
@@ -27,3 +48,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Test
+
+`rake test`

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+
+desc 'test'
+task :test do
+  system("rspec spec")
+end

data/left_side.gemspec

@@ -19,4 +19,13 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "cells",    "~> 3.7.1"
   gem.add_dependency "rails",    "~> 3.2.6"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "capybara"
+  gem.add_development_dependency "sass"
+
+  gem.add_development_dependency "launchy"
+  gem.add_development_dependency "debugger"
 end

data/lib/assets/stylesheets/left-side.css.scss

@@ -0,0 +1,55 @@
+$color1: #08c;       /* link text color */
+$color2: #e5e5e5;    /* hover text color */
+$color3: #999;       /* header text color */
+
+.left-side {
+  background-color: whiteSmoke;
+  width: 11.76462%;
+  padding: 9px 0;
+  font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+  font-size: 12px;
+  line-height: 18px;
+  border-radius: 4px;
+
+  ul, div, li{
+    margin: 0;
+    padding: 0;
+    border: 0;
+    -webkit-text-size-adjust: none;
+  }
+
+  .nav-list {
+    list-style: none;
+    text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+    
+    &> li {
+      line-height: 18px;
+      
+      &> a {
+        padding: 3px 15px;
+        display: block;
+        color: $color1;
+        text-decoration: none;
+        
+        &:hover {
+          background-color: $color2;
+        }
+      }
+      
+      &.active > a {
+        color: white;
+        background-color: $color1;
+      }
+    }
+   
+    .nav-header {
+      display: block;
+      padding: 3px 15px;
+      font-size: 11px;
+      font-weight: bold;
+      line-height: 18px;
+      color: $color3;
+      text-transform: uppercase;
+    }
+  }
+}

data/lib/left_side/base.rb

@@ -10,8 +10,8 @@ module LeftSide
         new
       end
 
-      def init_section_method
-        @@sections = YAML.load_file(File.join(File.dirname(__FILE__), 'section.yml'))
+      def init_section_method(file = File.join(File.dirname(__FILE__), 'section.yml'))
+        @@sections = YAML.load_file(file)
         define_section_method
       end
 
@@ -22,7 +22,7 @@ module LeftSide
             @@sections[section]
           end
 
-          # define method alias 
+          # define method alias
           hash = set_up.send section.to_sym
           # fetch values from hash with sub_hash(2 level at most)
           urls = hash.map{|k, v| v.is_a?(Hash) ? v.map{|kk, vv| vv} : v}.join(',').split(',')

data/lib/left_side/cells/left_side/base.html.erb

@@ -17,4 +17,4 @@
       <% end -%>
     <% end -%>
   <ul>
-</div>
+</div>

data/lib/left_side/cells/left_side_cell.rb

@@ -3,7 +3,8 @@ require 'cells'
 class LeftSideCell < Cell::Rails
 
   def base(args)
-    LeftSide::Base.init_section_method
+    #debugger
+    LeftSide::Base.init_section_method(File.join(::Rails.root, 'config', 'left_side', 'section.yml'))
     if LeftSide::Base.new.respond_to? args[:section]
       @sections = LeftSide::Base.new.send args[:section]
     else
@@ -12,4 +13,4 @@ class LeftSideCell < Cell::Rails
     append_view_path(File.dirname(__FILE__))
     render
   end
-end
+end

data/lib/left_side/rails.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), 'cells', 'left_side_cell')
 
 module LeftSide
   module Rails
-    
+
     module ActionView
       # render left side
       #
@@ -14,7 +14,7 @@ module LeftSide
       # It will render left side in this page
       #
       def render_left_side(name)
-        render_cell :left_side, :base, {:section => name}
+        render_cell :left_side, :base, {:section => name.singularize}
       end
     end
   end

data/lib/left_side/section.yml

@@ -1,7 +1,5 @@
 # encoding: utf-8
 all:
-  blogs:
-    index: ["/blogs", "/blogs/new"]
-  tasks:
-    index: "my_tasks"
-    new: "my_tasks/new"
+  todos:
+    index: "/todos"
+    new: "/todos/new"

data/lib/left_side/version.rb

@@ -1,3 +1,3 @@
 module LeftSide
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/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/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,12 @@
+// 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.
+//

data/spec/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 left-side
+ */

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

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

data/spec/dummy/app/controllers/tasks_controller.rb

@@ -0,0 +1,7 @@
+class TasksController < ApplicationController
+  def index
+  end
+
+  def new
+  end
+end

data/spec/dummy/app/controllers/todos_controller.rb

@@ -0,0 +1,7 @@
+class TodosController < ApplicationController
+  def index
+  end
+
+  def new
+  end
+end

data/spec/dummy/app/models/task.rb

@@ -0,0 +1,3 @@
+class Task < ActiveRecord::Base
+  # attr_accessible :title, :body
+end

data/spec/dummy/app/models/todo.rb

@@ -0,0 +1,3 @@
+class Todo < ActiveRecord::Base
+  # attr_accessible :title, :body
+end

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= stylesheet_link_tag    "application", :media => "all" %>
+    <%= javascript_include_tag "application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <% if content_for? :nav_left %>
+      <%= yield :nav_left %>
+    <% else %>
+      <%= render_left_side controller_name %>
+    <% end %>
+    <%= yield %>
+
+  </body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+if defined?(Bundler)
+  # If you precompile assets before deploying to production, use this line
+  Bundler.require(*Rails.groups(:assets => %w(development test)))
+  # If you want your assets lazily compiled in production, use this line
+  # Bundler.require(:default, :assets, Rails.env)
+end
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+# $:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# 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: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,67 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '803b81e60cf6f4713d8586258699db2cf1ee2f0ba1348ce42cc09d4609a0e2cb2c1ba4c9cdbb3205ec7270adaa46e7892acc9c68441ba5a2521343b58318c254'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dump_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dump::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/left_side/section.yml

@@ -0,0 +1,6 @@
+# encoding: utf-8
+todo:
+  todos:
+    index: ["/todos", "/todos/new"]
+  tasks:
+    index: "tasks"

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Dummy::Application.routes.draw do
+  resources :tasks
+
+  resources :todos
+end