super_crud 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Paul Narowski
+
+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/README.rdoc

@@ -0,0 +1,18 @@
+= super_crud
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 John Paul Narowski. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "super_crud"
+    gem.summary = %Q{Abstracts some helper model and controller logic}
+    gem.description = %Q{This is a admin system abstraction to get you up and running faster}
+    gem.email = "jnarowski@gmail.com"
+    gem.homepage = "http://github.com/jnarowski/super_crud"
+    gem.authors = ["John Paul Narowski"]
+    gem.files = [
+       "LICENSE",
+       "README.rdoc",
+       "Rakefile",
+       Dir["{spec,lib}/**/*"],
+       "test/helper.rb",
+       "test/test_metastrano.rb"
+    ]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "super_crud #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/super_crud.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/super_crud/controller'
+require File.dirname(__FILE__) + '/super_crud/helper'
+require File.dirname(__FILE__) + '/super_crud/model'

data/lib/super_crud/controller.rb

@@ -0,0 +1,166 @@
+module SuperCrud
+  module Controller 
+    
+    # def self.included(base)
+    #   base.extend(ClassMethods)
+    # end
+    #   
+    # module ClassMethods
+    #   def acts_as_super_crud
+    #     include SuperCrud::Controller
+    #   end
+    # end
+    
+    #----------------------------------------------------------------
+    # controller functionality
+    # -- you can override or extend if you want
+    #----------------------------------------------------------------
+
+    def display_list    
+      load_params
+      load_objects
+      update_list
+    end
+
+    def index
+      load_params
+      load_objects
+    end
+
+    def edit
+      respond_to do |format|
+        format.html # edit.html
+      end
+    end
+
+    def show
+      load_object
+    end
+
+    #----------------------------------------------------------------
+    # CRUD helper methods
+    #----------------------------------------------------------------
+
+    def _create(object, path = nil)
+      respond_to do |format|
+        if object.save
+          load_objects
+          flash[:notice] = "#{@_name} was successfully created."
+          format.html { redirect_to(set_path(object, path)) }
+        else
+          format.html { render :action => "new" }
+        end
+      end
+    end
+
+    def _update(object, path = nil)
+      respond_to do |format|
+        if object.update_attributes(@_attributes)
+          flash[:notice] = "#{@_name} was successfully updated."
+          format.html { redirect_to(set_path(object, path)) }
+        else
+          format.html { render :action => "edit" }
+        end
+      end
+    end
+
+    def _destroy(name, object, object_name)
+      object.destroy
+      respond_to do |format|
+        format.js { simple_destroy(name, object, :message => "#{object_name} has been removed.") }
+      end
+    end
+
+    #----------------------------------------------------------------
+    # helper functions
+    #----------------------------------------------------------------
+
+    # used to set the path in the #_update and #_create methods
+    def set_path(object, path)
+      path.blank? ? "#{@_path}/#{object.id}" : path
+    end
+
+    # if the user has searched, add the search filter parameter
+    # this will pop the box in the top of the table listing
+    def add_search_if_present(collections)
+      if params[:search]
+        @filter_text = "Search for '#{params[:search]}'"
+        collections.search(params[:search])
+      else
+        collections
+      end
+    end
+
+    # This is used to add extra parameters to the column_heading and pagination filtering
+    #   in the controller if you wanted to add the params[:search] to the filters
+    #   EG: add_extra_param(:search)
+    #
+    def add_filter_param(name)
+      @extra_params[name] = params[name] unless params[name].blank?
+    end
+
+    #----------------------------------------------------------------
+    # searching and sorting helpers
+    #----------------------------------------------------------------
+
+    def get_order(ordering, exact = false)
+      if ordering
+        order_array = ordering.split("_")
+        direction = (order_array[0] == 'ascend') ? 'ASC' : 'DESC'
+        column = ''
+        order_array.each_with_index {|a, index| column += "#{a}_" if index > 1}
+        column = column[0..-2]
+        "#{column} #{direction}"
+      end
+    end
+
+    #----------------------------------------------------------------
+    # shared rjs methods
+    #----------------------------------------------------------------
+
+    def update_list(options = {})      
+      options[:sidebar] = 'side_menu'    
+      render :update do |page|
+        page.replace_html 'list', :partial => 'list'
+        page.replace_html 'side-menu', :partial => options[:sidebar] if options[:reload_sidebar]    
+        page.replace_html options[:reload_partial], :partial => options[:reload_partial] if options[:reload_partial] 
+        # show the advanced filter text
+        unless @filter_text.blank?
+          page.replace_html 'filter', filter_results 
+          page.show "filter"
+        end
+      end
+    end
+
+    def simple_destroy(id, object, options = {})
+      dom_id = options[:id] ? options[:id] : "#{id}-#{object.id}"
+      render :update do |page|
+        page.remove dom_id
+      end
+    end
+
+    #----------------------------------------------------------------
+    # private functionaltiy
+    #----------------------------------------------------------------
+
+    private 
+
+      # this loads params for the index page 
+      # sets defaults for column sorting, searching etc
+      def load_params
+        super
+        @extra_params = {}
+        @ordering ||= 'descend_by_created_at'
+        add_filter_param(:search)
+      end
+
+      # sets page default options, selected tab states ETC
+      def initialize_page
+        super
+        action = action_name == 'index' ? "#{@_name}s" : "#{action_name.capitalize} #{@_name}"
+        @page_title = action
+        @render_options[:selected_tab] = @_selected_tab
+      end
+    end
+  
+end

data/lib/super_crud/helper.rb

@@ -0,0 +1,116 @@
+module SuperCrud
+  module Helper
+    #----------------------------------------------------------------
+    # framework stuff
+    #----------------------------------------------------------------
+
+    def filter_results
+      out = ""
+      out += "<div id=\"filter-results-count\" class=\"float-right\">#{@filter_count} found #{link_to(icon('cross'), {:controller => controller_name})}</div>" if @filter_count
+      out += "<div id=\"filter-results\">#{@filter_text}</div>#{}" if @filter_text
+      out
+    end
+
+  	def super_header(name, &block)
+  	  heading = "<h1>#{name}</h1>"
+  	  concat("<div id='sub-header'>#{capture(&block)}#{heading}#{float_clear}</div>")
+  	end
+
+  	def super_table(&block)
+  	  table_start = '<div id="filter" class="rounded" style="display: none;"></div>
+        <table class="stripped-list list" cellspacing="0" width="750px">'
+  	  concat("#{table_start}#{capture(&block)}</table>")    
+  	end
+
+  	def super_row(name, object, iterator = nil, &block)
+  	  line = (iterator ? iterator % 2 : 0)
+  	  concat("<tr id='#{name}-#{object.id}' class='line-#{line} padded-td'>#{capture(&block)}</tr>")    
+  	end
+
+  	def super_paginate(collection)
+  	  "<div id='table-footer'>#{super_custom_remote_paginate(collection)}</div>"
+  	end
+
+  	# table header
+  	def table_header(width, name, column, options = {})
+  	  filler = options[:plain_text].blank? ? super_column_heading(name, column) : name
+      "<th width='#{width}' class='#{options[:class]}'>#{filler}</th>"
+  	end
+
+  	def super_button(name, link, options = {})
+  	  div_style = options.delete(:div_style) 
+  	  "<div class='button' style='#{div_style}'>#{link_to(name, link, options)}</div>"
+  	end
+
+    def super_menu_item(name, link, selected = nil, options = {})
+      options[:class] = 'selected' if selected == @render_options[:selected_tab] && !@render_options[:selected_tab].blank?
+      "<li>#{link_to(name, link, options)}</li>"
+    end
+
+    #----------------------------------------------------------------
+    # general helpers
+    #----------------------------------------------------------------
+
+    def set_admin_url(object, path)
+      object.new_record? ? "/admin/#{path}/" : "/admin/#{path}/#{object.id}"
+    end
+
+    def super_icon(type, options = {})
+      width = 16
+      alt = nil
+      file_name = "#{type}.png"
+      "<img src=\"/images/icons/#{file_name}\" alt=\"#{alt ? alt : type}\" #{"title=\"#{alt}\"" if !alt.blank?} style=\"width: #{width}px;\" />"
+    end
+
+    #----------------------------------------------------------------
+    # show helpers
+    #----------------------------------------------------------------
+
+    def super_show_item(name, value)
+      value = value.blank? ? '<i>null</i>' : value
+      "<p>
+        <label class='strong'>#{name}</label>
+        #{value}      
+      </p>"
+    end
+
+    #----------------------------------------------------------------
+    # table sorting and filtering helpers
+    #----------------------------------------------------------------
+
+    def super_column_heading(display_name, attribute, controller = controller_name)
+      options = {
+        :controller => controller,
+        :action => 'display_list',
+        :ordering => ordering(attribute), 
+        :attribute => attribute.to_s 
+      }.merge!(@extra_params)  
+      link_to("#{display_name} #{super_triangle(attribute)}", options, :class => 'column-header')
+    end  
+
+    def super_custom_remote_paginate(collection, options = {})
+      options[:ordering] ||= @ordering
+      options[:attribute] ||= @attribute
+      options[:controller] ||= controller_name
+      options[:action] ||= 'display_list'
+      options[:method] ||= 'post'
+      options.merge!(@extra_params)
+      "<div class='pagination'>#{will_paginate(collection, :params => options, :remote => {})}</div>#{float_clear}"
+    end
+
+
+    def super_triangle(attribute)
+      return "&#9650;" if @ordering == "ascend_by_#{attribute}" 
+      return "&#9660;" if @ordering == "descend_by_#{attribute}" 
+    end
+
+    def ordering(attribute)
+      if @ordering == "ascend_by_#{attribute}" then
+        "descend_by_#{attribute}"
+      else
+        "ascend_by_#{attribute}"
+      end
+    end
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'super_crud'
+
+class Test::Unit::TestCase
+end

data/test/test_super_crud.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSuperCrud < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: super_crud
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Paul Narowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-25 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: This is a admin system abstraction to get you up and running faster
+email: jnarowski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/super_crud.rb
+- lib/super_crud/controller.rb
+- lib/super_crud/helper.rb
+- lib/super_crud/model.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/jnarowski/super_crud
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Abstracts some helper model and controller logic
+test_files: 
+- test/helper.rb
+- test/test_super_crud.rb