themes 0.0.2 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTNiMjQ5NDM2ZjUzYmI0MWM3YzQzNjFjOTEzN2NiNGUwYjE0ZDRhNA==
+  data.tar.gz: !binary |-
+    ZTBjZDUxZjRhNjM5ZTUzOWNhZDMzZmE5Mzk1MzJjN2VjYjg2N2YxYg==
+SHA512:
+  metadata.gz: !binary |-
+    YmI4NTczYTAzYzMyY2I2MzliODAzNDcyOGVjZDgyMzBjMjE4MGJjZTkzZjcx
+    MmRjYzYwODYxY2EwNTI2MjkwMjM2ZmI0ZTJkZDhkZDkzZTNmMGVlM2VmZTk5
+    OGE1Njc1N2JjOWFkZTA4NGUzNTkxZGEwMzg1MTYxYjQ4OWU3MTM=
+  data.tar.gz: !binary |-
+    OGNmYjNiNmI3MjY1MDQxNWQzYTEwMmY0ZWFmOTkxNzc0ZGI2ZjU2YjM3YTJh
+    ZDZlYjY0NzNkYmM2N2VjNzk4N2VjNmUwZmU1YmZmODBhNzg4Yjk2MmFlZTIy
+    NGZmMTY4ODZlZDc2ZjQ2NjliZDdjZTMzZGIxNWMzMzAzY2Q1Nzg=

data/README.md

@@ -2,6 +2,57 @@
 
 Add simple themes to your rails applications
 
+# Usage
+
+Gemfile:
+
+```ruby
+
+gem "themes"
+
+```
+
+Run bundler and then create your first theme:
+
+```bash
+
+$ bundle install
+$ rails generate themes:new my_theme sales@company.com
+
+```
+
+It will generate a configuration file.
+
+```ruby
+# encoding: utf-8
+
+class Themes::Loader
+  def self.configure(app)
+    app.config.theme.name = 'my_theme'
+    app.config.theme.email = 'sales@company.com'
+
+    development do
+      # Place development environment stuff here
+    end
+
+    production do
+      # Place production environment stuff here
+    end
+
+    test do
+      # Place test environment stuff here
+    end
+  end
+end
+
+```
+
+Folders to place views files and assets will be created.
+
+- app/assets/javascripts/my_theme
+- app/assets/stylesheets/my_theme
+- app/views/themes/my_theme
+
 ## Main features:
 
   - allow app to load diferent configuration depending on theme
@@ -13,3 +64,7 @@ Add simple themes to your rails applications
   - Use differnt theme depending on domain name
 
 
+## Code Status
+
+* [![Build Status](https://api.travis-ci.org/ritxi/themes.png)](https://travis-ci.org/ritxi/themes)
+* [![Coverage Status](https://coveralls.io/repos/ritxi/themes/badge.png)](https://coveralls.io/r/ritxi/themes)

data/Rakefile

@@ -25,14 +25,10 @@ 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
+require 'coveralls/rake/task'
+require 'rspec/core/rake_task'
+Coveralls::RakeTask.new('coveralls:push')
+RSpec::Core::RakeTask.new(:spec)
 
+task :default => :spec
 
-task :default => :test

data/lib/generators/themes/new_generator.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+class Themes::NewGenerator < Rails::Generators::NamedBase
+  class Environments
+    extend Themes::Environments
+  end
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :name, type: :string, default: [], banner: "theme_name"
+  argument :email, type: :string, default: [], banner: "theme_email"
+
+
+  def create_theme_configuration_file
+    template 'theme_loader.rb.erb', "config/themes/#{theme_name}.rb"
+  end
+
+  def create_views_initial_files
+    empty_directory "app/views/themes/#{theme_name}"
+    empty_directory "app/views/themes/#{theme_name}/layouts"
+  end
+
+  def create_assets_files
+    empty_directory "app/assets/stylesheets/#{theme_name}"
+    empty_directory "app/assets/javascripts/#{theme_name}"
+  end
+
+  def theme_name
+    name
+  end
+
+  def theme_email
+    email
+  end
+end

data/lib/generators/themes/templates/theme_loader.rb.erb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+class Themes::Loader
+  def self.configure(app)
+    app.config.theme.name = '<%= theme_name %>'
+    app.config.theme.email = '<%= theme_email %>'<% Environments.list.each do |env_name| %>
+
+    <%= env_name %> do
+      # Place <%= env_name %> environment stuff here
+    end<% end %>
+  end
+end

data/lib/themes.rb

@@ -6,8 +6,10 @@ module Themes
 
   mattr_accessor :email
   @@email = nil
+
+  autoload :Helpers, 'themes/helpers'
+  autoload :Paths, 'themes/paths'
+  autoload :Environments, 'themes/environments'
 end
 
-require 'themes/engine'
-require 'themes/helpers'
-require 'themes/paths'
+require 'themes/engine'

data/lib/themes/engine.rb

@@ -1,8 +1,12 @@
 module Themes
+  class Loader; end;
+
   class Engine < ::Rails::Engine
     config.theme = Themes
 
     initializer "themes.setup_theme", before: 'action_mailer.set_configs' do |app|
+      Themes::Loader.extend(Themes::Environments)
+
       require Rails.root.join('config', 'themes', ENV['APP_THEME'])
       Themes::Loader.configure(app)
     end

data/lib/themes/environments.rb

@@ -0,0 +1,17 @@
+module Themes
+  module Environments
+    def list
+      @list ||= Dir.entries(Rails.root.join('config', 'environments').to_s).
+        select{ |f| f.match /.*\.rb/ }.
+          map{|f| File.basename(f, '.rb').to_sym}.sort
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if block_given? && list.include?(method_name)
+        block.call if Rails.env.send("#{method_name}?")
+      else
+        super
+      end
+    end
+  end
+end

data/lib/themes/version.rb

@@ -1,3 +1,3 @@
 module Themes
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/spec/controllers/posts_controller_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe PostsController, controller: true do
+  describe "#index" do
+    before { get :index }
+
+    it { expect(response).to have_rendered('posts/index') }
+
+    context "render_views with theme custom views" do
+      render_views
+
+      it { expect(response.body).to match /Posts index from theme/m }
+      it { expect(response.body).to match /Test theme layout/m }
+    end
+
+    context "render_views with default views" do
+      pending "should be able to reload theme path"
+      #before do
+      #  ENV['APP_THEME']='empty'
+      #  subject
+      #end
+      #render_views
+      #
+      #it { expect(response.body).to match /Default posts index/m }
+      #it { expect(response.body).to match /Default layout/m }
+    end
+  end
+end

data/spec/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
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- 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.