admini 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1ca246591999312d4fb645e07db0908545a3d0d
-  data.tar.gz: fea1ddd7562e51df56f487d21b5773df2bfca5e7
+  metadata.gz: b54a44f81ceacbb98218300cb0915549dd4c521a
+  data.tar.gz: 2efb51f3cc96b43615c00c772d266ae267d52932
 SHA512:
-  metadata.gz: 6a0353dcbf993d93d98caac46c09d17313d1008093fe01a25a5416c548e0c4bc12b5d9d32a5ee2fa591a3956971307339780ff5bd044a61d1a4d1d602ebb0696
-  data.tar.gz: e06b9a436f94a80b041adeabbfaa1cd873f96aca71988111b9623224731b5f17c3634c567342188ad3294d3c41c9b6a3f6c95aa98ada4ae60f960db21b157704
+  metadata.gz: ed58c33259ae1e04a3426a5b5cba4de0e7c7b02b39a51de3e6668ee268258b17fea6a10bb31c67aec7a084207764123d301d2a2e76d130be2f1ad6213b7c0182
+  data.tar.gz: 9729485865f0afc978230496c313253e9b18034fe46c82232451670173d7fb43a5cb9e3d62ac5d1e4c0187caf3d4290cc3cbfb6f3e659391dedf8aaef98c1e7d

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/README.md

@@ -1,5 +1,6 @@
 # Admini
 
+[![Build Status](https://travis-ci.org/kami-zh/admini.svg?branch=master)](https://travis-ci.org/kami-zh/admini)
 [![Gem Version](https://badge.fury.io/rb/admini.svg)](https://badge.fury.io/rb/admini)
 
 Admini is a minimal administration framework for Ruby on Rails application.
@@ -12,6 +13,8 @@ Admini is the simplest framework, so you can create administration page accordin
 
 **Note**: Admini is still under development, and there may be breaking changes to the API.
 
+![](https://raw.githubusercontent.com/kami-zh/admini/master/docs/screenshot.png)
+
 ## Table of contents
 
 - [Demo](#demo)
@@ -37,9 +40,9 @@ Admini is the simplest framework, so you can create administration page accordin
 ## Demo
 
 You can try an administration page built with Admini at following link.
-The code of the demo can be found [here]().
+The code of the demo can be found [here](https://github.com/kami-zh/admini-demo).
 
-- http://example.com
+- https://admini.herokuapp.com/admin
 
 ## Installation
 

data/Rakefile

@@ -1,3 +1,7 @@
 require 'bundler'
+require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/admini.gemspec

@@ -14,9 +14,17 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files -z`.split("\x0")
 
-  s.add_dependency 'actionpack'
+  s.add_dependency 'actionview'
   s.add_dependency 'activesupport'
-  s.add_dependency 'jquery-rails'
   s.add_dependency 'simple_form'
   s.add_dependency 'kaminari'
+  s.add_dependency 'jquery-rails'
+
+  s.add_development_dependency 'actionpack'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rails-controller-testing'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'database_cleaner'
 end

data/app/assets/stylesheets/admini/default.css

@@ -104,6 +104,13 @@ select {
   vertical-align: middle;
 }
 
+.error {
+  display: block;
+  margin-top: 4px;
+  color: #e00;
+  font-size: .8rem;
+}
+
 .pagination {
   margin-bottom: 20px;
 }

data/app/controllers/concerns/admini/resources.rb

@@ -4,8 +4,6 @@ module Admini
   module Resources
     extend ActiveSupport::Concern
 
-    include ActionView::Helpers::FormOptionsHelper
-
     included do
       before_action :load_resources, only: :index
       before_action :load_resource, only: [:edit, :update, :show, :destroy]
@@ -13,10 +11,11 @@ module Admini
       before_action :search_resources, only: :index
       before_action :authorize
 
-      helper_method :resource_name,
-        :index_attributes,
+      helper_method :index_attributes,
         :new_attributes,
+        :create_attributes,
         :edit_attributes,
+        :update_attributes,
         :show_attributes,
         :search_attributes,
         :enum_attributes,
@@ -24,10 +23,9 @@ module Admini
         :can_read?,
         :can_update?,
         :can_delete?,
-        :enable_action?,
         :render_attribute,
-        :resource_object,
-        :search_options
+        :resource_name,
+        :resource_object
 
       layout 'admini/layouts/application'
     end
@@ -98,13 +96,7 @@ module Admini
     end
 
     def resource_params
-      attributes = case action_name
-                   when 'create'
-                     new_attributes
-                   when 'update'
-                     edit_attributes
-                   end
-      params.require(resource_name).permit(attributes)
+      params.require(resource_name).permit(send("#{action_name}_attributes"))
     end
 
     def search_resources
@@ -126,10 +118,18 @@ module Admini
       %i()
     end
 
+    def create_attributes
+      new_attributes
+    end
+
     def edit_attributes
       new_attributes
     end
 
+    def update_attributes
+      edit_attributes
+    end
+
     def search_attributes
       %i()
     end
@@ -181,20 +181,8 @@ module Admini
       end
     end
 
-    def enable_action?(action)
-      routes.include?(controller: controller_path, action: action.to_s)
-    end
-
-    def routes
-      @routes ||= Rails.application
-        .routes
-        .routes
-        .map(&:defaults)
-        .reject(&:blank?)
-    end
-
     def resource_object
-      defined?(super) ? super : [:admin, @resource]
+      defined?(super) ? super : [:admin, resource]
     end
 
     def render_attribute(resource, attribute)
@@ -205,14 +193,6 @@ module Admini
       end
     end
 
-    def search_options
-      options = []
-      search_attributes.each do |attribute|
-        options << [t("activerecord.attributes.#{resource_name}.#{attribute}"), attribute]
-      end
-      options_for_select(options)
-    end
-
     def paginates_per
       defined?(super) ? super : 25
     end

data/app/helpers/admini/application_helper.rb

@@ -0,0 +1,29 @@
+module Admini
+  module ApplicationHelper
+    include ActionView::Helpers::TranslationHelper
+    include ActionView::Helpers::FormOptionsHelper
+    include ActiveSupport::Multibyte::Unicode
+
+    def enable_action?(action)
+      routes.include?(controller: controller_path, action: action.to_s)
+    end
+
+    def search_options
+      options = []
+      search_attributes.each do |attribute|
+        options << [t("activerecord.attributes.#{resource_name}.#{attribute}", default: attribute.to_s.camelize), attribute]
+      end
+      options_for_select(options)
+    end
+
+    private
+
+    def routes
+      @routes ||= Rails.application
+        .routes
+        .routes
+        .map(&:defaults)
+        .reject(&:blank?)
+    end
+  end
+end

data/lib/admini/version.rb

@@ -1,3 +1,3 @@
 module Admini
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/spec/controllers/admin/posts_controller_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Admin::PostsController, type: :controller do
+  before do
+    Post.create(title: 'foo', content: 'foo')
+    Post.create(title: 'bar', content: 'bar')
+    Post.create(title: 'baz', content: 'baz')
+  end
+
+  describe '#resources' do
+    it 'returns all posts' do
+      get :index
+      expect(assigns(:resources).count).to eq 3
+    end
+  end
+
+  describe '#resource' do
+    it 'returns a post' do
+      get :show, params: { id: 1 }
+      expect(assigns(:resource).title).to eq 'foo'
+    end
+  end
+
+  describe '#build_resource' do
+    it 'creates a Post instance' do
+      get :new
+      expect(assigns(:resource)).to be_a_kind_of(Post)
+      expect(assigns(:resource)).not_to be_persisted
+    end
+
+    it 'creates a Post instance with params' do
+      post :create, params: { post: { title: 'qux', content: 'qux' } }
+      expect(assigns(:resource).title).to eq 'qux'
+    end
+  end
+
+  describe '#search_resources' do
+    it 'returns posts which includes keyword' do
+      get :index, params: { attribute: 'title', value: 'ba' }
+      expect(assigns(:resources).count).to eq 2
+    end
+  end
+
+  describe '#authorize' do
+    it 'raises error when access to prohibited action' do
+      expect { delete :destroy, params: { id: 1 } }.to raise_error(Admini::AuthorizationError)
+    end
+  end
+end

data/spec/dummy/application.rb

@@ -0,0 +1,98 @@
+require 'action_controller/railtie'
+require 'active_record'
+require 'admini'
+
+module Dummy
+  class Application < Rails::Application
+    config.secret_key_base = 'abcdefghijklmnopqrstuvwxyz0123456789'
+    config.eager_load = false
+  end
+end
+
+Dummy::Application.initialize!
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+
+#
+# Migrates
+#
+
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.string  :title,   null: false
+      t.text    :content, null: false
+      t.integer :status,  null: false, default: 0
+      t.timestamps null: false
+    end
+  end
+end
+
+CreateUsers.new.change
+CreatePosts.new.change
+
+#
+# Routes
+#
+
+Dummy::Application.routes.draw do
+  namespace :admin do
+    resources :users, only: [:index, :show]
+    resources :posts
+  end
+end
+
+#
+# Models
+#
+
+class User < ActiveRecord::Base; end
+
+class Post < ActiveRecord::Base
+  enum status: { draft: 0, published: 10 }
+end
+
+#
+# Controllers
+#
+
+module Admin; end
+
+class Admin::ApplicationController < ActionController::Base; end
+
+class Admin::PostsController < Admin::ApplicationController
+  include Admini::Resources
+
+  private
+
+  def show_attributes
+    %i(title content)
+  end
+
+  def new_attributes
+    %i(title content)
+  end
+
+  def search_attributes
+    %i(title)
+  end
+
+  def can_delete?
+    false
+  end
+
+  def render_content(resource)
+    'bar'
+  end
+end

data/spec/features/posts_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Posts', type: :feature do
+  describe 'GET /admin/posts/:id' do
+    before do
+      Post.create(title: 'foo', content: 'foo')
+      visit admin_post_path(id: 1)
+    end
+
+    it 'has attributes set by #show_attributes' do
+      expect(page).to have_content('foo')
+    end
+
+    it 'has attributes overridden by #render_attribute' do
+      expect(page).to have_content('bar')
+    end
+  end
+
+  describe 'GET /admin/posts/new' do
+    it 'renders with form object set by #resource_object' do
+      visit new_admin_post_path
+      expect(page).to have_http_status(:ok)
+    end
+  end
+end

data/spec/helpers/admini/application_helper_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+include Admini::ApplicationHelper
+
+describe Admini::ApplicationHelper do
+  describe '#enable_action?' do
+    context 'enable all actions' do
+      let(:controller_path) { 'admin/posts' }
+
+      it 'all returns true' do
+        %i(index new create show edit update destroy).each do |action|
+          expect(enable_action?(action)).to be_truthy
+        end
+      end
+    end
+
+    context 'enable some actions' do
+      let(:controller_path) { 'admin/users' }
+
+      it 'returns true when passed enable action, otherwise false' do
+        %i(index show).each do |action|
+          expect(enable_action?(action)).to be_truthy
+        end
+
+        %i(new create edit update destroy).each do |action|
+          expect(enable_action?(action)).to be_falsy
+        end
+      end
+    end
+  end
+
+  describe '#search_options' do
+    let(:resource_name) { 'post' }
+    let(:search_attributes) { %i(title content) }
+
+    it 'returns option tags' do
+      expect(search_options).to eq "<option value=\"title\">Title</option>\n<option value=\"content\">Content</option>"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'dummy/application'
+require 'rspec/rails'
+require 'rails-controller-testing'
+require 'capybara/rspec'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.include Rails::Controller::Testing::TestProcess, type: :controller
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: admini
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - kami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-01 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: simple_form
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_form
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +80,104 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A minimal administration framework for Ruby on Rails application.
 email: hiroki.zenigami@gmail.com
 executables: []
@@ -87,6 +185,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -95,6 +194,7 @@ files:
 - app/assets/javascripts/admini/application.js
 - app/assets/stylesheets/admini/default.css
 - app/controllers/concerns/admini/resources.rb
+- app/helpers/admini/application_helper.rb
 - app/views/admini/layouts/_header.html.erb
 - app/views/admini/layouts/_nav.html.erb
 - app/views/admini/layouts/_search.html.erb
@@ -111,9 +211,15 @@ files:
 - app/views/admini/shared/links/_show.html.erb
 - config/locales/admini.en.yml
 - config/locales/admini.ja.yml
+- docs/screenshot.png
 - lib/admini.rb
 - lib/admini/engine.rb
 - lib/admini/version.rb
+- spec/controllers/admin/posts_controller_spec.rb
+- spec/dummy/application.rb
+- spec/features/posts_spec.rb
+- spec/helpers/admini/application_helper_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/kami-zh/admini
 licenses:
 - MIT