RubyGems - merb-slices - Versions diffs - 0.9.7 → 0.9.8 - Mend

merb-slices 0.9.7 → 0.9.8

Files changed (68) hide show

data/README +4 -4
data/Rakefile +27 -13
data/TODO +1 -2
data/bin/slice +77 -0
data/lib/generators/templates/common/Rakefile +16 -12
data/lib/generators/templates/full/README +4 -4
data/lib/generators/templates/full/Rakefile +32 -13
data/lib/generators/templates/full/config/init.rb +43 -0
data/lib/generators/templates/full/lib/%base_name%.rb +3 -1
data/lib/generators/templates/full/spec/%base_name%_spec.rb +10 -121
data/lib/generators/templates/full/spec/controllers/main_spec.rb +18 -8
data/lib/generators/templates/thin/README +4 -4
data/lib/generators/templates/very_thin/README +4 -4
data/lib/merb-slices.rb +3 -3
data/lib/merb-slices/controller_mixin.rb +34 -7
data/lib/merb-slices/merbtasks.rb +5 -34
data/lib/merb-slices/module.rb +9 -3
data/lib/merb-slices/module_mixin.rb +19 -31
data/lib/merb-slices/router_ext.rb +10 -7
data/spec/full_slice_generator_spec.rb +31 -2
data/spec/full_slice_spec.rb +162 -0
data/spec/merb-slice_spec.rb +97 -3
data/spec/slice_generator_spec.rb +15 -3
data/spec/slices/full-test-slice/LICENSE +20 -0
data/spec/slices/full-test-slice/README +170 -0
data/spec/slices/full-test-slice/Rakefile +67 -0
data/spec/slices/full-test-slice/TODO +15 -0
data/spec/slices/full-test-slice/app/controllers/application.rb +5 -0
data/spec/slices/full-test-slice/app/controllers/main.rb +7 -0
data/spec/slices/full-test-slice/app/helpers/application_helper.rb +64 -0
data/spec/slices/full-test-slice/app/views/layout/full_test_slice.html.erb +16 -0
data/spec/slices/full-test-slice/app/views/main/index.html.erb +1 -0
data/spec/slices/full-test-slice/config/init.rb +43 -0
data/spec/slices/full-test-slice/lib/full-test-slice.rb +80 -0
data/spec/slices/full-test-slice/lib/full-test-slice/merbtasks.rb +103 -0
data/spec/slices/full-test-slice/lib/full-test-slice/slicetasks.rb +18 -0
data/spec/slices/full-test-slice/lib/full-test-slice/spectasks.rb +65 -0
data/spec/slices/full-test-slice/public/javascripts/master.js +0 -0
data/spec/slices/full-test-slice/public/stylesheets/master.css +2 -0
data/spec/slices/full-test-slice/stubs/app/controllers/application.rb +2 -0
data/spec/slices/full-test-slice/stubs/app/controllers/main.rb +2 -0
data/spec/slices/thin-test-slice/LICENSE +20 -0
data/spec/slices/thin-test-slice/README +130 -0
data/spec/slices/thin-test-slice/Rakefile +43 -0
data/spec/slices/thin-test-slice/TODO +7 -0
data/spec/slices/thin-test-slice/application.rb +36 -0
data/spec/slices/thin-test-slice/lib/thin-test-slice.rb +93 -0
data/spec/slices/thin-test-slice/lib/thin-test-slice/merbtasks.rb +103 -0
data/spec/slices/thin-test-slice/lib/thin-test-slice/slicetasks.rb +18 -0
data/spec/slices/thin-test-slice/public/javascripts/master.js +0 -0
data/spec/slices/thin-test-slice/public/stylesheets/master.css +2 -0
data/spec/slices/thin-test-slice/stubs/application.rb +9 -0
data/spec/slices/thin-test-slice/views/layout/thin_test_slice.html.erb +16 -0
data/spec/slices/thin-test-slice/views/main/index.html.erb +1 -0
data/spec/slices/very-thin-test-slice/LICENSE +20 -0
data/spec/slices/very-thin-test-slice/README +110 -0
data/spec/slices/very-thin-test-slice/Rakefile +43 -0
data/spec/slices/very-thin-test-slice/TODO +7 -0
data/spec/slices/very-thin-test-slice/application.rb +36 -0
data/spec/slices/very-thin-test-slice/lib/very-thin-test-slice.rb +89 -0
data/spec/slices/very-thin-test-slice/lib/very-thin-test-slice/merbtasks.rb +103 -0
data/spec/slices/very-thin-test-slice/lib/very-thin-test-slice/slicetasks.rb +18 -0
data/spec/spec_helper.rb +27 -2
data/spec/thin_slice_generator_spec.rb +24 -2
data/spec/thin_slice_spec.rb +139 -0
data/spec/very_thin_slice_generator_spec.rb +22 -2
data/spec/very_thin_slice_spec.rb +119 -0
metadata +79 -5

data/spec/slices/full-test-slice/app/views/layout/full_test_slice.html.erb ADDED Viewed

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <title>Fresh FullTestSlice Slice</title>
+    <link href="<%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all" />
+    <script src="<%= public_path_for :javascript, 'master.js' %>" type="text/javascript" charset="utf-8"></script>
+  </head>
+  <!-- you can override this layout at slices/full-test-slice/app/views/layout/full-test-slice.html.erb -->
+  <body class="full-test-slice-slice">
+  <div id="container">
+	  <h1>FullTestSlice Slice</h1>
+    <div id="main"><%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/spec/slices/full-test-slice/app/views/main/index.html.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <strong><%= slice.description %></strong> (v. <%= slice.version %>)

data/spec/slices/full-test-slice/config/init.rb ADDED Viewed

@@ -0,0 +1,43 @@
+#
+# ==== Standalone FullTestSlice configuration
+#
+# This configuration/environment file is only loaded by bin/slice, which can be
+# used during development of the slice. It has no effect on this slice being
+# loaded in a host application. To run your slice in standalone mode, just
+# run 'slice' from its directory. The 'slice' command is very similar to
+# the 'merb' command, and takes all the same options, including -i to drop
+# into an irb session for example.
+#
+# The usual Merb configuration directives and init.rb setup methods apply,
+# including use_orm and before_app_loads/after_app_loads.
+#
+# If you need need different configurations for different environments you can
+# even create the specific environment file in config/environments/ just like
+# in a regular Merb application.
+#
+# In fact, a slice is no different from a normal # Merb application - it only
+# differs by the fact that seamlessly integrates into a so called 'host'
+# application, which in turn can override or finetune the slice implementation
+# code and views.
+#
+Merb::Config.use do |c|
+  # Sets up a custom session id key which is used for the session persistence
+  # cookie name.  If not specified, defaults to '_session_id'.
+  # c[:session_id_key] = '_session_id'
+  # The session_secret_key is only required for the cookie session store.
+  c[:session_secret_key]  = '780af855b5f47a1033726be3fabad8113a3d34a4'
+  # There are various options here, by default Merb comes with 'cookie',
+  # 'memory', 'memcache' or 'container'.
+  # You can of course use your favorite ORM instead:
+  # 'datamapper', 'sequel' or 'activerecord'.
+  c[:session_store] = 'cookie'
+  # When running a slice standalone, you're usually developing it,
+  # so enable template reloading by default.
+  c[:reload_templates] = true
+end

data/spec/slices/full-test-slice/lib/full-test-slice.rb ADDED Viewed

@@ -0,0 +1,80 @@
+if defined?(Merb::Plugins)
+  $:.unshift File.dirname(__FILE__)
+  load_dependency 'merb-slices'
+  Merb::Plugins.add_rakefiles "full-test-slice/merbtasks", "full-test-slice/slicetasks", "full-test-slice/spectasks"
+  # Register the Slice for the current host application
+  Merb::Slices::register(__FILE__)
+  # Slice configuration - set this in a before_app_loads callback.
+  # By default a Slice uses its own layout, so you can swicht to
+  # the main application layout or no layout at all if needed.
+  #
+  # Configuration options:
+  # :layout - the layout to use; defaults to :full-test-slice
+  # :mirror - which path component types to use on copy operations; defaults to all
+  Merb::Slices::config[:full_test_slice][:layout] ||= :full_test_slice
+  # All Slice code is expected to be namespaced inside a module
+  module FullTestSlice
+    # Slice metadata
+    self.description = "FullTestSlice is a chunky Merb slice!"
+    self.version = "0.0.1"
+    self.author = "YOUR NAME"
+    # Stub classes loaded hook - runs before LoadClasses BootLoader
+    # right after a slice's classes have been loaded internally.
+    def self.loaded
+    end
+    # Initialization hook - runs before AfterAppLoads BootLoader
+    def self.init
+    end
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+    end
+    # Deactivation hook - triggered by Merb::Slices.deactivate(FullTestSlice)
+    def self.deactivate
+    end
+    # Setup routes inside the host application
+    #
+    # @param scope<Merb::Router::Behaviour>
+    #  Routes will be added within this scope (namespace). In fact, any
+    #  router behaviour is a valid namespace, so you can attach
+    #  routes at any level of your router setup.
+    #
+    # @note prefix your named routes with :full_test_slice_
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+      # example of a named route
+      scope.match('/index(.:format)').to(:controller => 'main', :action => 'index').name(:index)
+      # the slice is mounted at /full-test-slice - note that it comes before default_routes
+      scope.match('/').to(:controller => 'main', :action => 'index').name(:home)
+    end
+  end
+  # Setup the slice layout for FullTestSlice
+  #
+  # Use FullTestSlice.push_path and FullTestSlice.push_app_path
+  # to set paths to full-test-slice-level and app-level paths. Example:
+  #
+  # FullTestSlice.push_path(:application, FullTestSlice.root)
+  # FullTestSlice.push_app_path(:application, Merb.root / 'slices' / 'full-test-slice')
+  # ...
+  #
+  # Any component path that hasn't been set will default to FullTestSlice.root
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  FullTestSlice.setup_default_structure!
+  # Add dependencies for other FullTestSlice classes below. Example:
+  # dependency "full-test-slice/other"
+end

data/spec/slices/full-test-slice/lib/full-test-slice/merbtasks.rb ADDED Viewed

@@ -0,0 +1,103 @@
+namespace :slices do
+  namespace :full_test_slice do
+    desc "Install FullTestSlice"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    desc "Test for any dependencies"
+    task :preflight do # see slicetasks.rb
+    end
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      FullTestSlice.mirrored_components.each do |type|
+        if File.directory?(FullTestSlice.dir_for(type))
+          if !File.directory?(dst_path = FullTestSlice.app_dir_for(type))
+            relative_path = dst_path.relative_path_from(Merb.root)
+            puts "- creating directory :#{type} #{File.basename(Merb.root) / relative_path}"
+            mkdir_p(dst_path)
+          end
+        end
+      end
+    end
+    desc "Copy stub files to host application"
+    task :stubs do
+      puts "Copying stubs for FullTestSlice - resolves any collisions"
+      copied, preserved = FullTestSlice.mirror_stubs!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    desc "Copy stub files and views to host application"
+    task :patch => [ "stubs", "freeze:views" ]
+    desc "Copy public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for FullTestSlice - resolves any collisions"
+      copied, preserved = FullTestSlice.mirror_public!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    desc "Migrate the database"
+    task :migrate do # see slicetasks.rb
+    end
+    desc "Freeze FullTestSlice into your app (only full-test-slice/app)"
+    task :freeze => [ "freeze:app" ]
+    namespace :freeze do
+      desc "Freezes FullTestSlice by installing the gem into application/gems"
+      task :gem do
+        ENV["GEM"] ||= "full-test-slice"
+        Rake::Task['slices:install_as_gem'].invoke
+      end
+      desc "Freezes FullTestSlice by copying all files from full-test-slice/app to your application"
+      task :app do
+        puts "Copying all full-test-slice/app files to your application - resolves any collisions"
+        copied, preserved = FullTestSlice.mirror_app!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freeze all views into your application for easy modification"
+      task :views do
+        puts "Copying all view templates to your application - resolves any collisions"
+        copied, preserved = FullTestSlice.mirror_files_for :view
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freeze all models into your application for easy modification"
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = FullTestSlice.mirror_files_for :model
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freezes FullTestSlice as a gem and copies over full-test-slice/app"
+      task :app_with_gem => [:gem, :app]
+      desc "Freezes FullTestSlice by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking FullTestSlice files to your application - resolves any collisions"
+        copied, preserved = FullTestSlice.unpack_slice!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+    end
+  end
+end

data/spec/slices/full-test-slice/lib/full-test-slice/slicetasks.rb ADDED Viewed

@@ -0,0 +1,18 @@
+namespace :slices do
+  namespace :full_test_slice do
+    # add your own full-test-slice tasks here
+    # implement this to test for structural/code dependencies
+    # like certain directories or availability of other files
+    desc "Test for any dependencies"
+    task :preflight do
+    end
+    # implement this to perform any database related setup steps
+    desc "Migrate the database"
+    task :migrate do
+    end
+  end
+end

data/spec/slices/full-test-slice/lib/full-test-slice/spectasks.rb ADDED Viewed

@@ -0,0 +1,65 @@
+namespace :slices do
+  namespace :full_test_slice do
+    desc "Run slice specs within the host application context"
+    task :spec => [ "spec:explain", "spec:default" ]
+    namespace :spec do
+      slice_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      task :explain do
+        puts "\nNote: By running FullTestSlice specs inside the application context any\n" +
+             "overrides could break existing specs. This isn't always a problem,\n" +
+             "especially in the case of views. Use these spec tasks to check how\n" +
+             "well your application conforms to the original slice implementation."
+      end
+      Spec::Rake::SpecTask.new('default') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+      desc "Run all model specs, run a spec for a specific Model with MODEL=MyModel"
+      Spec::Rake::SpecTask.new('model') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MODEL'])
+          t.spec_files = Dir["#{slice_root}/spec/models/**/#{ENV['MODEL']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/models/**/*_spec.rb"].sort
+        end
+      end
+      desc "Run all controller specs, run a spec for a specific Controller with CONTROLLER=MyController"
+      Spec::Rake::SpecTask.new('controller') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/#{ENV['CONTROLLER']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/*_spec.rb"].sort
+        end
+      end
+      desc "Run all view specs, run specs for a specific controller (and view) with CONTROLLER=MyController (VIEW=MyView)"
+      Spec::Rake::SpecTask.new('view') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'] and ENV['VIEW'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/#{ENV['VIEW']}*_spec.rb"].sort
+        elsif(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/*_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/views/**/*_spec.rb"].sort
+        end
+      end
+      desc "Run all specs and output the result in html"
+      Spec::Rake::SpecTask.new('html') do |t|
+        t.spec_opts = ["--format", "html"]
+        t.libs = ['lib', 'server/lib' ]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+    end
+  end
+end

data/spec/slices/full-test-slice/public/javascripts/master.js ADDED Viewed

File without changes

data/spec/slices/full-test-slice/public/stylesheets/master.css ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ html, body { margin: 0; padding: 0; }
2	+ #container { width: 800px; margin: 4em auto; padding: 4em 4em 6em 4em; background: #DDDDDD; }

data/spec/slices/full-test-slice/stubs/app/controllers/application.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class FullTestSlice::Application < Merb::Controller
2	+ end

data/spec/slices/full-test-slice/stubs/app/controllers/main.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class FullTestSlice::Main < FullTestSlice::Application
2	+ end

data/spec/slices/thin-test-slice/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2008 YOUR NAME
+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/spec/slices/thin-test-slice/README ADDED Viewed

@@ -0,0 +1,130 @@
+ThinTestSlice
+=============
+A thin slice for the Merb framework.
+------------------------------------------------------------------------------
+thin-test-slice
+|-- LICENSE
+|-- README
+|-- Rakefile [1]
+|-- TODO
+|-- application.rb [2]
+|-- lib
+|   |-- thin-test-slice
+|   |   |-- merbtasks.rb [3]
+|   |   `-- slicetasks.rb [4]
+|   `-- thin-test-slice.rb [5]
+|-- public [6]
+|   |-- javascripts
+|   |   `-- master.js
+|   `-- stylesheets
+|       `-- master.css
+|-- stubs [7]
+|   `-- application.rb
+`-- views [8]
+    |-- layout
+    |   `-- thin-test-slice.html.erb [9]
+    `-- main
+        `-- index.html.erb
+1. Rake tasks to package/install the gem - edit this to modify the manifest.
+2. The slice application in a single file: controllers, models, helper methods.
+3. Standard rake tasks available to your application.
+4. Your custom application rake tasks.
+5. The main slice file - contains all slice setup logic/config.
+6. Public assets you (optionally) install using rake slices:my_slice:install
+7. Stubs of classes/views/files for the end-user to override - usually these
+   mimic the files in app/ and/or public/; use rake slices:thin-test-slice:stubs to
+   get started with the override stubs. Also, slices:thin-test-slice:patch will
+   copy over views to override in addition to the files found in /stubs.
+8. A thin slice stores its views seperately.
+9. The default layout, as specified in Merb::Slices::config[:my_slice][:layout]
+   change this to :application to use the app's layout.
+To see all available tasks for ThinTestSlice run:
+rake -T slices:thin-test-slice
+------------------------------------------------------------------------------
+Instructions for installation:
+file: config/init.rb
+# add the slice as a regular dependency
+dependency 'thin-test-slice'
+# if needed, configure which slices to load and in which order
+Merb::Plugins.config[:merb_slices] = { :queue => ["ThinTestSlice", ...] }
+# optionally configure the plugins in a before_app_loads callback
+Merb::BootLoader.before_app_loads do
+  Merb::Slices::config[:thin_test_slice][:option] = value
+end
+file: config/router.rb
+# example: /thin-test-slice/:controller/:action/:id
+add_slice(:ThinTestSlice)
+# example: /foo/:controller/:action/:id
+add_slice(:ThinTestSlice, 'foo') # same as :path => 'foo'
+# example: /:lang/:controller/:action/:id (with :a param set)
+add_slice(:ThinTestSlice, :path => ':lang', :params => { :a => 'b' })
+# example: /:controller/:action/:id
+slice(:ThinTestSlice)
+Normally you should also run the following rake task:
+rake slices:thin_test_slice:install
+------------------------------------------------------------------------------
+About Slices
+============
+Merb-Slices is a Merb plugin for using and creating application 'slices' which
+help you modularize your application. Usually these are reuseable extractions
+from your main app. In effect, a Slice is just like a regular Merb MVC
+application, both in functionality as well as in structure.
+When you generate a Slice stub structure, a module is setup to serve as a
+namespace for your controller, models, helpers etc. This ensures maximum
+encapsulation. You could say a Slice is a mixture between a Merb plugin (a
+Gem) and a Merb application, reaping the benefits of both.
+A host application can 'mount' a Slice inside the router, which means you have
+full over control how it integrates. By default a Slice's routes are prefixed
+by its name (a router :namespace), but you can easily provide your own prefix
+or leave it out, mounting it at the root of your url-schema. You can even
+mount a Slice multiple times and give extra parameters to customize an
+instance's behaviour.
+A Slice's Application controller uses controller_for_slice to setup slice
+specific behaviour, which mainly affects cascaded view handling. Additionaly,
+this method is available to any kind of controller, so it can be used for
+Merb Mailer too for example.
+There are many ways which let you customize a Slice's functionality and
+appearance without ever touching the Gem-level code itself. It's not only easy
+to add template/layout overrides, you can also add/modify controllers, models
+and other runtime code from within the host application.
+To create your own Slice run this (somewhere outside of your merb app):
+$ merb-gen slice <your-lowercase-slice-name>