simple_admin 0.1.0

data/lib/simple_admin/breadcrumbs.rb

@@ -0,0 +1,24 @@
+module SimpleAdmin
+  class Breadcrumbs
+    # Returns an array of links to use in a breadcrumb
+    def self.parse(path, action)
+      parts = path.gsub(/^\//, '').split('/')
+      parts.pop unless %w{ create update }.include?(action)
+      crumbs = []
+      parts.each_with_index do |part, index|
+        name = ""
+        if part =~ /^\d/ && parent = parts[index - 1]
+          begin
+            parent_class = parent.singularize.camelcase.constantize
+            obj = parent_class.find(part.to_i)
+            name = obj.display_name if obj.respond_to?(:display_name)
+          rescue
+          end
+        end
+        name = part.titlecase if name == ""
+        crumbs << [name, "/" + parts[0..index].join('/')]
+      end
+      crumbs
+    end
+  end
+end

data/lib/simple_admin/builder.rb

@@ -0,0 +1,35 @@
+module SimpleAdmin
+  class Builder
+    attr_accessor :interface
+
+    def initialize(interface, &block)
+      @interface = interface
+      instance_eval(&block) if block_given?
+    end
+
+    def section(sym, options={}, &block)
+      @interface.sections[sym] = SimpleAdmin::Section.new(@interface, sym, options, &block)
+    end
+
+    def index(options={}, &block)
+      section(:index, options, &block)
+    end
+
+    def form(options={}, &block)
+      section(:form, options, &block)
+    end
+
+    def show(options={}, &block)
+      section(:show, options, &block)
+    end
+
+    def before(options={}, &block)
+      options[:data] = block
+      options[:actions] = options[:actions] || [:index, :show, :edit, :new, :delete, :create, :update]
+      options[:actions] -= options[:except] if options[:except]
+      options[:actions] &= options[:only] if options[:only]
+      @interface.before << options
+    end
+
+  end
+end

data/lib/simple_admin/engine.rb

@@ -0,0 +1,8 @@
+require 'simple_admin'
+require 'rails'
+
+module SimpleAdmin
+  class Engine < Rails::Engine
+    isolate_namespace SimpleAdmin
+  end
+end

data/lib/simple_admin/filters.rb

@@ -0,0 +1,5 @@
+module SimpleAdmin
+  class Filters < Attributes
+    alias_method :filter, :attribute
+  end
+end

data/lib/simple_admin/interface.rb

@@ -0,0 +1,55 @@
+require 'ostruct'
+
+module SimpleAdmin
+  class Interface
+    attr_reader :collection, :member, :constant, :options, :before, :sections
+
+    def initialize(resource, options={}, &block)
+      if resource.is_a?(Class)
+        @constant = resource
+        @symbol = resource.name.downcase.to_sym
+      else
+        @constant = resource.to_s.camelize.singularize.constantize
+        @symbol = resource.to_sym
+      end
+      @member = @symbol.to_s.singularize
+      @collection = @symbol.to_s.pluralize
+      @options = options
+      @sections = {}
+      @before = []
+      @builder = SimpleAdmin::Builder.new(self, &block)
+      self
+    end
+
+    def filters_for(sym)
+      section(sym).options[:filters].attributes
+    end
+
+    def attributes_for(sym)
+      section(sym).options[:attributes].attributes
+    end
+
+    def sidebars_for(sym)
+      section(sym).options[:sidebars] || []
+    end
+
+    def options_for(sym)
+      section(sym).options
+    end
+
+    def actions
+      arr =  @options[:actions] || [:index, :show, :edit, :new, :delete, :create, :update]
+      arr -= @options[:except] if @options[:except]
+      arr &= @options[:only] if @options[:only]
+      arr
+    end
+
+    private
+
+    def section(sym)
+      @sections[sym] ||= SimpleAdmin::Section.new(self, sym)
+      @sections[sym]
+    end
+
+  end
+end

data/lib/simple_admin/section.rb

@@ -0,0 +1,30 @@
+module SimpleAdmin
+  class Section
+    attr_accessor :options, :section
+
+    def initialize(interface, section, options={}, &block)
+      @interface = interface
+      @section = section
+      @options = options
+      @allow_filters = (section == :index)
+      attributes
+      filters if @allow_filters
+      instance_eval(&block) if block_given?
+    end
+
+    def attributes(attr_options={}, &block)
+      self.options[:attributes] = SimpleAdmin::Attributes.new(@interface, self, attr_options, &block)
+    end
+
+    def filters(filter_options={}, &block)
+      raise "Filters cannot be specified for this section" unless @allow_filters
+      self.options[:filters] = SimpleAdmin::Filters.new(@interface, self, filter_options, &block)
+    end
+
+    def sidebar(sidebar_options={}, &block)
+      sidebar_options[:data] = block
+      self.options[:sidebars] ||= []
+      self.options[:sidebars] << sidebar_options
+    end
+  end
+end

data/lib/simple_admin/version.rb

@@ -0,0 +1,3 @@
+module SimpleAdmin
+  VERSION = "0.1.0"
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# This is here so that this can be treated like a plugin instead of a gem
+require 'simple_admin'

data/simple_admin.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_admin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_admin"
+  s.version     = SimpleAdmin::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeff Rafter"]
+  s.email       = ["jeffrafter@gmail.com"]
+  s.homepage    = "http://github.com/jeffrafter/simple_admin"
+  s.summary     = %q{Simple administrative interfaces for data in your rails application}
+  s.description = %q{Use SimpleAdmin to build out filtering, searchable, editable interfaces for your models}
+
+  s.rubyforge_project = "simple_admin"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Formtastic is a dependency if you are using the default form helper
+  s.add_runtime_dependency("rails", [">= 3.1.0rc4"])
+  s.add_runtime_dependency("kaminari", [">= 0"])
+  s.add_runtime_dependency("meta_search", [">= 1.1.0.pre"])
+
+  s.add_development_dependency("rspec", [">= 2.6.0"])
+  s.add_development_dependency("rspec-rails", [">= 2.6.0"])
+  s.add_development_dependency("shoulda", [">= 0"])
+  s.add_development_dependency("factory_girl", [">= 0"])
+  s.add_development_dependency("mocha", ["> 0"])
+  s.add_development_dependency("capybara", [">= 0.4.0"])
+  s.add_development_dependency("sqlite3-ruby")
+end

data/spec/acceptance/admin_thing_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+feature "Things admin" do
+  background do
+#    mocha_teardown
+  end
+
+  scenario "Viewing a list of things" do
+    visit "/things"
+    page.should have_content("things")
+#    flunk
+  end
+end

data/spec/controllers/simple_admin/admin_controller_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe SimpleAdmin::AdminController do
+  render_views
+
+  before :each do
+    @thing = Factory(:thing)
+  end
+
+  describe "index" do
+    it "should render the template" do
+      get :index, :interface => "things"
+    end
+
+    it "should render the sidebars" do
+      SimpleAdmin.expects(:success)
+      @block = Proc.new {|sidebar| SimpleAdmin.success if sidebar[:title] == 'Awes!' }
+      @sidebar = {:title => 'Awes!', :data => @block}
+      SimpleAdmin::Interface.any_instance.expects(:sidebars_for).with(:index).returns([@sidebar])
+      get :index, :interface => "things"
+    end
+
+    it "should render a csv" do
+      get :index, :interface => "things", :format => "csv"
+    end
+  end
+
+  describe "new" do
+    it "should render the template" do
+      get :new, :interface => "things"
+    end
+  end
+
+  describe "show" do
+    it "should render the template" do
+      get :show, :id => @thing.id, :interface => "things"
+    end
+  end
+
+  describe "edit" do
+    it "should render the template" do
+      get :edit, :id => @thing.id, :interface => "things"
+    end
+  end
+
+  describe "create" do
+    before :each do
+      @params = {:interface => "things", :thing => Factory.attributes_for(:thing)}
+    end
+
+    it "should create a new thing" do
+      expect {
+        post :create, @params
+      }.to change(Thing, :count)
+
+      Thing.last.name.should == @params[:thing][:name]
+    end
+
+    it "should redirect to the collection page" do
+      post :create, @params
+
+      response.should be_redirect
+    end
+  end
+
+  describe "update" do
+    before :each do
+      @params = {:id => @thing.id, :interface => "things", :thing => Factory.attributes_for(:thing)}
+    end
+
+    it "should update a thing" do
+      expect {
+        post :update, @params
+      }.to_not change(Thing, :count)
+
+      @thing.reload
+      @thing.name.should == @params[:thing][:name]
+    end
+
+    it "should redirect to the collection page" do
+      post :update, @params
+
+      response.should be_redirect
+    end
+  end
+
+  describe "destroy" do
+    it "should destroy a thing" do
+      expect {
+        post :destroy, :id => @thing.id, :interface => "things"
+      }.to change(Thing, :count)
+    end
+  end
+
+end

data/spec/factories.rb

@@ -0,0 +1,14 @@
+Factory.sequence :name_sequence do |n|
+  "name #{n}"
+end
+
+Factory.define :place do |f|
+  f.name { Factory.next :name_sequence }
+end
+
+Factory.define :thing do |f|
+  f.name { Factory.next :name_sequence }
+  f.happy true
+  f.age 10
+  f.association :place
+end

data/spec/simple_admin/attributes_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe SimpleAdmin::Attributes do
+
+  before :each do
+    @interface = SimpleAdmin.register(:thing)
+    @section = @interface.send(:section, :index)
+    @attributes = SimpleAdmin::Attributes.new(@interface, @section)
+  end
+
+  describe "initialize" do
+    it "defaults the attributes on initialize" do
+      @attributes.attributes.should_not be_blank
+    end
+
+    it "executes the block if submitted" do
+      @attributes = SimpleAdmin::Attributes.new(@interface, @section) do
+        clear
+      end
+      @attributes.attributes.should be_blank
+     end
+  end
+
+  describe "clear" do
+    it "clears the list of attributes" do
+      @attributes.clear
+      @attributes.attributes.should be_blank
+    end
+  end
+
+  describe "defaults" do
+    it "creates a default set of attributes based on the columns" do
+      @attributes.attributes.map(&:attribute).should == [:id, :name, :happy, :age, :place_id, :created_at, :updated_at]
+    end
+
+    it "rejects attributes that are listed in the except option" do
+      @attributes = SimpleAdmin::Attributes.new(@interface, @section, :except => [:created_at, :updated_at])
+      @attributes.attributes.map(&:attribute).should == [:id, :name, :happy, :age, :place_id]
+    end
+
+    it "only includes attributes that are listed in the only option" do
+      @attributes = SimpleAdmin::Attributes.new(@interface, @section, :only => [:name, :happy, :age])
+      @attributes.attributes.map(&:attribute).should == [:name, :happy, :age]
+    end
+
+    it "only includes content attributes if the attributes are on a form section" do
+      @section = @interface.send(:section, :form)
+      @attributes = SimpleAdmin::Attributes.new(@interface, @section)
+      @attributes.attributes.map(&:attribute).should_not include(:id)
+    end
+
+    it "excludes skipped attributes if the attributes are on a form section" do
+      @section = @interface.send(:section, :form)
+      @attributes = SimpleAdmin::Attributes.new(@interface, @section)
+      @attributes.attributes.map(&:attribute).should_not include(:created_at)
+    end
+  end
+
+  describe "attribute" do
+    before :each do
+      @attributes.clear
+    end
+
+    it "adds an attribute" do
+      @attributes.attribute(:name)
+      @attributes.attributes.map(&:attribute).should == [:name]
+    end
+
+    it "sets the title" do
+      @attributes.attribute(:name)
+      @attributes.attribute(:age, :title => "Awesome age!")
+      @attributes.attributes.map(&:title).should == ["Name", "Awesome age!"]
+    end
+
+    it "defaults to being sortable" do
+      @attributes.attribute(:name)
+      @attributes.attributes.map(&:sortable).should == [true]
+    end
+
+    it "allows you to mark an attribute as unsortable" do
+      @attributes.attribute(:age, :sortable => false)
+      @attributes.attribute(:happy, :sortable => true)
+      @attributes.attributes.map(&:sortable).should == [false, true]
+    end
+
+    it "allows an alternate sort key" do
+      @attributes.attribute(:name)
+      @attributes.attribute(:happy, :sort_key => :name)
+      @attributes.attributes.map(&:sort_key).should == ["name", "name"]
+    end
+
+    it "accepts a block" do
+      @attributes.attribute(:name) do |object|
+        object
+      end
+      @attributes.attributes.last.data.call(true).should == true
+    end
+
+    it "overrides previously defined attributes" do
+      @attributes.attribute(:name)
+      @attributes.attribute(:name, :title => "Your Name Here")
+      @attributes.attributes.map(&:title).should == ["Your Name Here"]
+    end
+  end
+end
+

data/spec/simple_admin/breadcrumbs_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe SimpleAdmin::Breadcrumbs do
+  it "parses the path" do
+    SimpleAdmin::Breadcrumbs.parse("/admin/things", "index").should == [["Admin", "/admin"]]
+  end
+
+  it "includes the last step if creating" do
+    SimpleAdmin::Breadcrumbs.parse("/admin/things", "create").should == [["Admin", "/admin"], ["Things", "/admin/things"]]
+  end
+
+  it "finds the object and uses the display name" do
+    @thing = Factory(:thing)
+    Thing.any_instance.expects(:display_name).returns("A Thing!")
+    SimpleAdmin::Breadcrumbs.parse("/things/#{@thing.id}", "create").should == [["Things", "/things"],["A Thing!", "/things/#{@thing.id}"]]
+  end
+end
+