smart_managing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49cbf703ed43cf9df32be9fd23c6f7b5a8362d05
+  data.tar.gz: a217f2218b52f4ef1ec58b442d3a183ee0f33bc1
+SHA512:
+  metadata.gz: 17dd2d044b7bd782c35f8ab23d1a9ab447b142b2d3b88022acdb9629c7b8ca870bd3977d73a61bd56c31ce27d049c1bd909382b981b8304e87e1392d19239775
+  data.tar.gz: 09d9e5cc327d0c3961f1ec28275969520f3d774d912e1b5dc2031f7a395c73176737ddf8562855c528b86572c580c554567daa3b9ea9f9e7ad48a11316d0d29d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.md

@@ -0,0 +1,114 @@
+# SmartManaging
+
+SmartManaging is a tool which allow create easily a beautiful management interface while keeping the agility and the power of Rails.
+
+## Install in an existing project
+
+SmartManging uses SmartListing, SimpleForm and Twitter-Bootsrap. You must to
+install it before to install SmartManaging.
+
+To install SmartManaging you have to add this in your Gemfile :
+```ruby
+gem 'smart_listing', github: 'GCorbel/smart_listing', branch: 'refactoring'
+gem 'smart_managing'
+```
+
+Bundle it by using the command `bundle install`.
+
+Finally, you must to add this line in you controller :
+```ruby
+include SmartManaging::ControllerHelpers
+```
+
+## Start from scratch
+
+Here is an example of managing interface in less than 30 seconds
+
+Create the application :
+```console
+rails new UserManagement --skip-bundle
+cd UserManagement
+```
+
+Add this in your Gemfile :
+```ruby
+gem 'smart_listing', github: 'GCorbel/smart_listing', branch: 'refactoring'
+gem 'smart_managing'
+```
+
+Run this command to download the gem with Bundler :
+```console
+bundle install
+```
+
+Install SimpleForm by typing this command :
+```console
+rails generate simple_form:install
+```
+
+Install SmartManaging by running this command :
+```console
+rails generate smart_managing:install
+```
+
+Create a new model, for example :
+```console
+rails generate model User name email age:integer
+rake db:migrate
+```
+
+Edit the `config/routes.rb` and add :
+```ruby
+resources :users
+```
+
+Open the file `app/assets/javascripts/application.js` and, before `//= require_tree .`, add this :
+```
+//= require bootstrap
+//= require smart_listing
+```
+
+Rename the file `app/assets/stylesheets/application.css` to `app/assets/stylesheets/application.css.scss` and, at the bottom of the file, add this :
+```scss
+@import "bootstrap-sprockets";
+@import "bootstrap";
+```
+
+Create a file named `app/controllers/users_controller.rb` and add this :
+```ruby
+class UsersController < ApplicationController
+  include SmartManaging::ControllerHelpers
+  # ... Your code
+end
+```
+
+For a more simple controller, you can use [inherited_resources](https://github.com/josevalim/inherited_resources) but it's not mandatory.
+
+Done! You can start the application by running `rails server` and go to http://localhost:3000.
+
+## Customize the managers
+You can change the behavior of the SmartManaging for a specific model by creating a directory `app/managers` and a manager object. For exemple, you can have the file `user_manager.rb` which contain :
+
+```ruby
+class UserManager < SmartManaging::Base
+  def editable_attributes
+    ['name']
+  end
+
+  def attributes
+    ['name', 'email']
+  end
+end
+```
+
+This will show only the names and emails and allow to edit only the names.
+
+A manager class must inherited from `SmartManaging::Base` and override his methods, for the complete list of overrideable methods, you can check [this file](https://github.com/GCorbel/smart_managing/blob/master/app/managers/smart_managing/base.rb).
+
+You can specify a manager in the controller by overriding the `manager` method. For example, you can do this :
+
+```ruby
+def manager
+  @manager ||= CustomManager.new(self)
+end
+```

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmartManaging'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/helpers/smart_managing/application_helper.rb

@@ -0,0 +1,32 @@
+module SmartManaging
+  module ApplicationHelper
+    delegate :attributes, :editable_attributes, :number_of_attributes,
+      to: :manager
+
+    def colspan
+      number_of_attributes + 1
+    end
+
+    def resource_name
+      controller_name.to_sym
+    end
+
+    def new_item_path
+      new_polymorphic_path(klass)
+    end
+
+    private
+
+    def klass
+      controller_name.classify.constantize
+    end
+
+    def resource_name
+      controller_name.to_sym
+    end
+
+    def singular_resource_name
+      resource_name.to_s.singularize.to_sym
+    end
+  end
+end

data/app/managers/smart_managing/base.rb

@@ -0,0 +1,35 @@
+module SmartManaging
+  class Base
+    attr_accessor :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def number_of_attributes
+      attributes.size
+    end
+
+    def attributes
+      klass.columns.map(&:name)
+    end
+
+    def klass
+      controller_name.classify.constantize
+    end
+
+    def editable_attributes
+      attributes - SmartManaging::UNEDITABLE_ATTRIBUTES
+    end
+
+    def model_sym
+      controller_name.to_s.singularize.to_sym
+    end
+
+    private
+
+    def controller_name
+      controller.controller_name
+    end
+  end
+end

data/app/views/smart_managing/_form.html.erb

@@ -0,0 +1,16 @@
+<td colspan="<%= colspan %>">
+  <%= simple_form_for object, remote: true,
+    wrapper: :smart_managing_form,
+    html: { class: 'form-horizontal' } do |f| %>
+    <% editable_attributes.each do |attr| %>
+      <%= f.input attr %>
+    <% end %>
+    <div class="form-group">
+      <label class="control-label col-md-3"></label>
+      <div class="col-md-5">
+        <%= f.button :submit, "Save", class: "btn btn-primary" %>
+        <button class="btn btn-link cancel">Cancel</button>
+      </div>
+    </div>
+  <% end %>
+</td>

data/app/views/smart_managing/_item.html.erb

@@ -0,0 +1,10 @@
+<% attributes.each do |attr| %>
+  <td>
+    <%= object.send(attr) %>
+  </td>
+<% end %>
+<td class="actions">
+  <%= smart_listing_item_actions [
+    {name: :edit, url: edit_polymorphic_path(object)},
+    {name: :destroy, url: polymorphic_path(object), confirmation: 'Sure?'}] %>
+</td>

data/app/views/smart_managing/_list.html.erb

@@ -0,0 +1,19 @@
+<table class="table table-striped">
+  <thead>
+    <% attributes.each do |attr| %>
+      <th><%= attr.humanize %></th>
+    <% end %>
+    <th></th>
+  </thead>
+  <tbody>
+    <% smart_listing.collection.each do |resource| %>
+      <tr class="editable" data-id="<%= resource.id %>">
+        <%= smart_listing.render object: resource, partial: 'item',
+          locals: { object: resource } %>
+      </tr>
+    <% end %>
+    <%= smart_listing.item_new colspan: colspan, link: new_item_path %>
+  </tbody>
+</table>
+<%= smart_listing.paginate %>
+<%= smart_listing.pagination_per_page_links %>

data/app/views/smart_managing/index.html.erb

@@ -0,0 +1 @@
+<%= smart_listing_render %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/smart_managing/install/install_generator.rb

@@ -0,0 +1,9 @@
+class SmartManaging::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc 'Copy initializer files'
+  def copy_initializer
+    template 'initializer.rb', 'config/initializers/smart_managing.rb'
+    template 'simple_form_smart_managing.rb', 'config/initializers/simple_form_smart_managing.rb'
+  end
+end

data/lib/generators/smart_managing/install/templates/initializer.rb

@@ -0,0 +1 @@
+Dir["#{Rails.root}/app/managers/*.rb"].each {|file| require file }

data/lib/generators/smart_managing/install/templates/simple_form_smart_managing.rb

@@ -0,0 +1,12 @@
+SimpleForm.setup do |config|
+  config.wrappers :smart_managing_form, tag: 'div', class: 'control-group form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label, class: 'col-md-3'
+    b.wrapper tag: 'div' do |ba|
+      ba.use :input, class: 'form-control', wrap_with: { tag: 'div', class: 'col-md-5' }
+      ba.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+      ba.use :hint, wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+end

data/lib/smart_managing/controller_helpers.rb

@@ -0,0 +1,50 @@
+module SmartManaging
+  module ControllerHelpers
+
+    def index
+      smart_listing_create partial: 'list'
+      respond_to do |format|
+        format.html { render formats: :html }
+        format.js { render formats: :js }
+      end
+    end
+
+    private
+
+    def self.included(c)
+      return unless c < ActionController::Base
+      c.helper_method :manager
+      c.include SmartListing::Helper::ControllerExtensions
+      c.helper  SmartListing::Helper
+      c.respond_to :html, :js
+    end
+
+    def manager
+      @manager ||= manager_class.new(self)
+    end
+
+    def manager_class
+      custom_class? ? custom_class : SmartManaging::Base
+    end
+
+    def custom_class?
+      Object.const_defined?(custom_manager_name)
+    end
+
+    def custom_class
+      custom_manager_name.constantize
+    end
+
+    def custom_manager_name
+      "#{controller_name.classify}Manager"
+    end
+
+    def _prefixes
+      super << 'smart_managing'
+    end
+
+    def build_resource_params
+      [params.fetch(manager.model_sym, {}).permit(manager.attributes)]
+    end
+  end
+end

data/lib/smart_managing/engine.rb

@@ -0,0 +1,4 @@
+module SmartManaging
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/smart_managing/version.rb

@@ -0,0 +1,3 @@
+module SmartManaging
+  VERSION = "0.0.1"
+end

data/lib/smart_managing.rb

@@ -0,0 +1,11 @@
+require 'jquery-rails'
+require 'coffee-rails'
+require 'bootstrap-sass'
+require 'smart_listing'
+require 'simple_form'
+require 'smart_managing/engine'
+require 'smart_managing/controller_helpers'
+
+module SmartManaging
+  UNEDITABLE_ATTRIBUTES = ['id', 'created_at', 'updated_at']
+end

data/lib/tasks/smart_managing_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :smart_managing do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: smart_managing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guirec Corbel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: smart_listing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0.rc2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- guirec.corbel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/smart_managing/application_helper.rb
+- app/managers/smart_managing/base.rb
+- app/views/smart_managing/_form.html.erb
+- app/views/smart_managing/_item.html.erb
+- app/views/smart_managing/_list.html.erb
+- app/views/smart_managing/index.html.erb
+- config/routes.rb
+- lib/generators/smart_managing/install/install_generator.rb
+- lib/generators/smart_managing/install/templates/initializer.rb
+- lib/generators/smart_managing/install/templates/simple_form_smart_managing.rb
+- lib/smart_managing.rb
+- lib/smart_managing/controller_helpers.rb
+- lib/smart_managing/engine.rb
+- lib/smart_managing/version.rb
+- lib/tasks/smart_managing_tasks.rake
+homepage: https://github.com/GCorbel/smart_managing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Easy way to create a managing interface.
+test_files: []