qadmin 0.2.0

data/test/test_generator_helper.rb

@@ -0,0 +1,29 @@
+begin
+  require File.dirname(__FILE__) + '/test_helper'
+rescue LoadError
+  require 'test/unit'
+end
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+# if defined?(RAILS_ROOT)
+#   RAILS_ROOT.replace(app_root)
+# else
+#   RAILS_ROOT = app_root
+# end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_helper.rb

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'stringio'
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+
+require File.dirname(__FILE__) + '/../lib/qadmin'
+
+
+# mock AR::BASE
+module ActiveRecord
+  class Base
+    class << self
+      attr_accessor :pluralize_table_names
+      
+      def protected_attributes
+        []
+      end
+      
+      def column_names
+        ['id'] #content_columns.collect {|c| c.name }
+      end
+      
+    end
+    self.pluralize_table_names = true
+  end
+end
+
+
+
+class MockColumn
+  attr_accessor :name, :type
+
+  def initialize(name, type)
+    self.name = name
+    self.type = type
+  end
+
+  def human_name
+    name.to_s.humanize
+  end
+  
+  def default
+    nil
+  end
+end
+
+class Item < ActiveRecord::Base
+
+  class << self
+
+    def content_columns
+      columns = {
+        :name => :string,
+        :sku  => :string,
+        :description => :text,
+        :made_at => :datetime,
+        :price => :float,
+        :created_at => :datetime,
+        :updated_at => :datetime
+      }
+      columns.collect do |name, type|
+        MockColumn.new(name, type)
+      end
+    end
+    
+    def column_names
+      [] #content_columns.collect {|c| c.name }
+    end
+  end
+end
+
+class MockController
+  class << self
+    def append_view_path(paths)
+    end
+    
+    def helper_method(*args)
+    end
+  end
+  
+  extend Qadmin::Controller::Macros
+end

data/test/test_qadmin_controller.rb

@@ -0,0 +1,148 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestQadminController < Test::Unit::TestCase
+
+  protected  
+  def crud_actions
+    [:index, :show, :new, :create, :edit, :update, :destroy]
+  end
+  
+  def assert_defines_actions(*actions)
+    [actions].flatten.each do |action|
+      assert @controller.respond_to?(action), "Should define ##{action}"
+    end
+  end
+  
+  def assert_does_not_define_actions(*actions)
+    [actions].flatten.each do |action|
+      assert !@controller.respond_to?(action), "Should not define ##{action}"
+    end
+  end
+  public
+
+  context "QadminController" do
+    context "Macros" do
+      context "#qadmin" do
+        
+        context "with no options" do
+          setup do
+            class ::NoOption < ActiveRecord::Base; end
+            class NoOptionsController < MockController
+              qadmin
+            end
+            @controller = NoOptionsController.new
+          end
+          
+          should "define all CRUD actions" do
+            assert_defines_actions(crud_actions)
+          end
+          
+          should "set qadmin configuration" do
+            assert @controller.send(:qadmin_configuration).is_a?(Qadmin::Configuration)
+          end
+          
+          should "set model_name from controller name" do
+            assert_equal 'NoOption', @controller.send(:model_name)
+          end
+          
+          should "set model_instance_name to underscored version" do
+            assert_equal 'no_option', @controller.send(:model_instance_name)
+          end
+          
+          should "set human_name to model.humanize" do
+            assert_equal 'No option', @controller.send(:model_human_name)
+          end
+        end
+        
+        context "with hashed options" do
+          context "with :exclude" do
+            setup do
+              class ::Exclude < ActiveRecord::Base; end
+              class ExcludeController < MockController
+                qadmin :available_actions => {:exclude => [:show, :destroy]}
+              end
+              @controller = ExcludeController.new
+            end
+            
+            should "define CRUD actions" do
+              assert_defines_actions(crud_actions - [:show, :destroy])
+            end
+            
+            should "not define actions in exclude" do
+              assert_does_not_define_actions([:show, :destroy])
+            end
+          end
+          
+          context "with :only" do
+            setup do
+              class ::Only < ActiveRecord::Base; end
+              class OnlyController < MockController
+                qadmin :available_actions => {:only => [:index, :show]}
+              end
+              @controller = OnlyController.new
+            end
+            
+            should "define CRUD actions" do
+              assert_defines_actions(:index, :show)
+            end
+            
+            should "not define actions in exclude" do
+              assert_does_not_define_actions(crud_actions - [:index, :show])
+            end
+          end
+          
+          context "with :model_name" do
+            should "set #model_name" do
+              
+            end
+          end
+          
+          context "with :human_name" do
+            
+            should "set the human name" do
+              
+            end
+            
+            should "not effect the existing model name" do
+              
+            end
+          end
+          
+          context "with two instances in different controllers" do
+            setup do
+              class ::NewExclude < ActiveRecord::Base; end
+              class NewExcludeController < MockController
+                qadmin do |config|
+                  config.available_actions.exclude = [:show, :new]
+                end
+              end
+              @exclude_controller = NewExcludeController.new
+              class NewOnlyController < MockController
+                qadmin :model_name => 'Item', :available_actions => {:only => [:index, :show]}
+              end
+              @only_controller = NewOnlyController.new
+            end
+            
+            should "not include actions for :exclude" do
+              @controller = @exclude_controller
+              assert_does_not_define_actions(:show, :new)
+              assert_defines_actions(crud_actions - [:show, :new])
+            end
+            
+            should "include actions for :only" do
+              @controller = @only_controller
+              assert_does_not_define_actions(crud_actions - [:index, :show])
+              assert_defines_actions([:index, :show])
+            end
+            
+            should "set model name independently" do
+              assert_equal 'Item', @only_controller.send(:model_name)
+              assert_equal 'NewExclude', @exclude_controller.send(:model_name)
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end

data/test/test_qadmin_generator.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+require 'rails_generator'
+
+class TestQadminGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+    base_files.each do |file|
+      full_path = File.join(APP_ROOT, file)
+      FileUtils.mkdir_p(File.dirname(full_path))
+      File.open(full_path, 'w') {|f| f << '' }
+    end
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  def test_generator_with_model_without_options
+    name = 'Item'
+    run_generator('qadmin', [name], sources, :destination => APP_ROOT)
+    assert_generated_class('app/controllers/items_controller') do |body|
+      assert_match(/qadmin/, body)
+    end
+    assert_generated_class('test/functional/items_controller_test')
+    assert_directory_exists('app/views/items')
+    assert_generated_file('app/views/items/_form.html.erb')
+    assert_generated_file('app/views/layouts/admin.html.erb')
+    assert_directory_exists('public/images/admin/')
+  end
+  
+  def test_generator_with_after_scaffold_should_only_generate_test_and_erbs
+    name = 'Item'
+    run_generator('qadmin', [name, '--after-scaffold'], sources, :destination => APP_ROOT)
+    assert_file_does_not_exist('app/controllers/items_controller.rb')
+    assert_generated_class('test/functional/items_controller_test')
+    assert_generated_file('app/views/items/_form.html.erb')
+    assert_generated_file('app/views/items/_item.html.erb')    
+    assert_file_does_not_exist('app/views/layouts/admin.erb')
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "rails_generators"
+  end
+  
+  def assert_file_does_not_exist(path)
+      assert !File.exist?("#{APP_ROOT}/#{path}"),
+        "The file '#{APP_ROOT}/#{path}' should not exist"
+  end
+  
+  def base_files
+    [ 
+      'public/stylesheets/style.css',
+      'app/views/layouts/main.erb',
+      'config/routes.rb'
+    ]
+  end
+  
+  def silence_generator
+    logger_original = Rails::Generator::Base.logger
+    myout = StringIO.new
+    Rails::Generator::Base.logger = Rails::Generator::SimpleLogger.new(myout)
+    yield if block_given?
+    Rails::Generator::Base.logger = logger_original
+    myout.string
+  end
+  
+end

data/test/test_qadmin_option_set.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestQadminOptionSet < Test::Unit::TestCase
+
+  context "OptionSet" do
+    context "initializing" do
+      context "with an array" do
+        setup do
+          @option_set = Qadmin::OptionSet.new([:index, :show, :delete])
+        end
+        
+        should "set array as default" do
+          assert_equal [:index, :show, :delete], @option_set.default
+        end
+        
+        should "return array as current" do
+          assert_equal [:index, :show, :delete], @option_set.current
+        end
+      end
+      
+      context "with only options" do
+        setup do
+          @option_set = Qadmin::OptionSet.new(:default => [:index, :show, :delete], :exclude => :delete)
+        end
+        
+        should "set default with options" do
+          assert_equal [:index, :show, :delete], @option_set.default
+        end
+        
+        should "set exclude with options" do
+          assert_equal [:delete], @option_set.exclude
+        end
+      end
+      
+      context "with an array and options" do
+        setup do
+          @option_set = Qadmin::OptionSet.new([:index, :show, :delete], :only => :delete)
+        end
+        
+        should "set default as array" do
+          assert_equal [:index, :show, :delete], @option_set.default
+        end
+        
+        should "set only with options" do
+          assert_equal [:delete], @option_set.only
+        end
+      end
+    end
+    
+    context "an Option Set" do
+      context "with exclude set" do
+        setup do
+          @option_set = Qadmin::OptionSet.new(:default => [:index, :show, :delete], :exclude => :delete)
+        end
+        
+        should "return current without excludes" do
+          assert_equal [:index, :show], @option_set.current
+        end
+        
+        should "itterate over current" do
+          @option_set.each do |option|
+            assert [:index, :show].include?(option)
+          end
+        end
+      end
+      
+      context "with only set" do
+        setup do
+          @option_set = Qadmin::OptionSet.new(:default => [:index, :show, :delete], :only => [:show, :delete])
+        end
+        
+        should "return only as current" do
+          assert_equal [:show, :delete], @option_set.current
+        end
+        
+        should "itterate over only" do
+          @option_set.each do |option|
+            assert [:show, :delete].include?(option)
+          end
+
+        end        
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: qadmin
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aaron Quint
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: restful_query
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: Shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: An [almost] one command solution for adding admin interfaces/resources to a Rails app.
+email: 
+- aaron@quirkey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/qadmin.rb
+- lib/qadmin/assets/form_builder.rb
+- lib/qadmin/configuration.rb
+- lib/qadmin/controller.rb
+- lib/qadmin/form_builder.rb
+- lib/qadmin/helper.rb
+- lib/qadmin/option_set.rb
+- lib/qadmin/overlay.rb
+- lib/qadmin/page_titles.rb
+- lib/qadmin/templates.rb
+- lib/qadmin/views/content_forms/_attachments_form.erb
+- lib/qadmin/views/content_forms/_photos_form.erb
+- lib/qadmin/views/content_forms/_videos_form.erb
+- lib/qadmin/views/default/edit.erb
+- lib/qadmin/views/default/index.erb
+- lib/qadmin/views/default/new.erb
+- lib/qadmin/views/default/show.erb
+- rails/init.rb
+- rails_generators/qadmin/USAGE
+- rails_generators/qadmin/qadmin_generator.rb
+- rails_generators/qadmin/templates/_form.html.erb
+- rails_generators/qadmin/templates/_instance.html.erb
+- rails_generators/qadmin/templates/controller.rb
+- rails_generators/qadmin/templates/functional_test.rb
+- rails_generators/qadmin/templates/images/icon_asc.gif
+- rails_generators/qadmin/templates/images/icon_desc.gif
+- rails_generators/qadmin/templates/images/icon_destroy.png
+- rails_generators/qadmin/templates/images/icon_edit.png
+- rails_generators/qadmin/templates/images/icon_export.png
+- rails_generators/qadmin/templates/images/icon_find.png
+- rails_generators/qadmin/templates/images/icon_import.png
+- rails_generators/qadmin/templates/images/icon_list.png
+- rails_generators/qadmin/templates/images/icon_new.png
+- rails_generators/qadmin/templates/images/icon_next.gif
+- rails_generators/qadmin/templates/images/icon_prev.gif
+- rails_generators/qadmin/templates/images/icon_show.png
+- rails_generators/qadmin/templates/images/icon_sort.png
+- rails_generators/qadmin/templates/images/indicator_medium.gif
+- rails_generators/qadmin/templates/layout.html.erb
+- rails_generators/qadmin/templates/style.css
+- test/test_generator_helper.rb
+- test/test_helper.rb
+- test/test_qadmin_controller.rb
+- test/test_qadmin_generator.rb
+- test/test_qadmin_option_set.rb
+has_rdoc: true
+homepage: http://github.com/quirkey/qadmin
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: quirkey
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: An [almost] one command solution for adding admin interfaces/resources to a Rails app.
+test_files: 
+- test/test_generator_helper.rb
+- test/test_helper.rb
+- test/test_qadmin_controller.rb
+- test/test_qadmin_generator.rb
+- test/test_qadmin_option_set.rb