manage 1.2.0 → 1.3.0

data/config/initializers/devise.rb

@@ -0,0 +1,247 @@
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # The secret key used by Devise. Devise uses this key to generate
+  # random tokens. Changing this key will render invalid all existing
+  # confirmation, reset password and unlock tokens in the database.
+  config.secret_key = 'cfd1236b63220546d94fbed7e953a984a6491f3a8bc1130c423439102bf1affb8ef64f5df5e36b9bd181c304204fe6c2e532982f0f359a068af9aa127e2cb064'
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  # config.authentication_keys = [ :email ]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :email.
+  config.case_insensitive_keys = [ :email ]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :email.
+  config.strip_whitespace_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication. The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If http headers should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing :skip => :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments.
+  config.stretches = Rails.env.test? ? 1 : 10
+
+  # Setup a pepper to generate the encrypted password.
+  # config.pepper = '7c21a253b30401590aa2948d35eb4fa6d0f1017e825c14a1ab1878f57c70e23a5b3b88126fda5dec2fbf7ec3298cf3f2e80a38fd4aa9527bdee53b636265011e'
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming his account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming his account,
+  # access will be blocked just in the third day. Default is 0.days, meaning
+  # the user cannot access the website without confirming his account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed new email is stored in
+  # unconfirmed email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [ :email ]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # :secure => true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length. Default is 8..128.
+  config.password_length = 8..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  # config.email_regexp = /\A[^@]+@[^@]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # If true, expires auth token on session timeout.
+  # config.expire_auth_token_on_timeout = false
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [ :email ]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = false
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [ :email ]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another encryption algorithm besides bcrypt (default). You can use
+  # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
+  # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
+  # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
+  # REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  config.scoped_views = true
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :admin_user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(:scope => :user).unshift :some_external_strategy
+  # end
+
+  #config.router_name = :manage
+
+  #
+  # When using omniauth, Devise cannot automatically set Omniauth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+end

data/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Yatoto::Application.config.session_store :cookie_store, key: '_YatotoManage_session'

data/config/initializers/simple_form_foundation.rb

@@ -14,4 +14,6 @@ SimpleForm.setup do |config|
     # does't provide styles for hints. You will need to provide your own CSS styles for hints.
     # b.use :hint,  wrap_with: { tag: :span, class: :hint }
   end
+
+  config.form_class = 'simple_form custom'
 end

data/config/locales/devise.en.yml

@@ -0,0 +1,59 @@
+# Additional translations at https://github.com/plataformatec/devise/wiki/I18n
+
+en:
+  devise:
+    confirmations:
+      confirmed: "Your account was successfully confirmed."
+      send_instructions: "You will receive an email with instructions about how to confirm your account in a few minutes."
+      send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions about how to confirm your account in a few minutes."
+    failure:
+      already_authenticated: "You are already signed in."
+      inactive: "Your account is not activated yet."
+      invalid: "Invalid email or password."
+      locked: "Your account is locked."
+      last_attempt: "You have one more attempt before your account will be locked."
+      not_found_in_database: "Invalid email or password."
+      timeout: "Your session expired. Please sign in again to continue."
+      unauthenticated: "You need to sign in or sign up before continuing."
+      unconfirmed: "You have to confirm your account before continuing."
+    mailer:
+      confirmation_instructions:
+        subject: "Confirmation instructions"
+      reset_password_instructions:
+        subject: "Reset password instructions"
+      unlock_instructions:
+        subject: "Unlock Instructions"
+    omniauth_callbacks:
+      failure: "Could not authenticate you from %{kind} because \"%{reason}\"."
+      success: "Successfully authenticated from %{kind} account."
+    passwords:
+      no_token: "You can't access this page without coming from a password reset email. If you do come from a password reset email, please make sure you used the full URL provided."
+      send_instructions: "You will receive an email with instructions about how to reset your password in a few minutes."
+      send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
+      updated: "Your password was changed successfully. You are now signed in."
+      updated_not_active: "Your password was changed successfully."
+    registrations:
+      destroyed: "Bye! Your account was successfully cancelled. We hope to see you again soon."
+      signed_up: "Welcome! You have signed up successfully."
+      signed_up_but_inactive: "You have signed up successfully. However, we could not sign you in because your account is not yet activated."
+      signed_up_but_locked: "You have signed up successfully. However, we could not sign you in because your account is locked."
+      signed_up_but_unconfirmed: "A message with a confirmation link has been sent to your email address. Please open the link to activate your account."
+      update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and click on the confirm link to finalize confirming your new email address."
+      updated: "You updated your account successfully."
+    sessions:
+      signed_in: "Signed in successfully."
+      signed_out: "Signed out successfully."
+    unlocks:
+      send_instructions: "You will receive an email with instructions about how to unlock your account in a few minutes."
+      send_paranoid_instructions: "If your account exists, you will receive an email with instructions about how to unlock it in a few minutes."
+      unlocked: "Your account has been unlocked successfully. Please sign in to continue."
+  errors:
+    messages:
+      already_confirmed: "was already confirmed, please try signing in"
+      confirmation_period_expired: "needs to be confirmed within %{period}, please request a new one"
+      expired: "has expired, please request a new one"
+      not_found: "not found"
+      not_locked: "was not locked"
+      not_saved:
+        one: "1 error prohibited this %{resource} from being saved:"
+        other: "%{count} errors prohibited this %{resource} from being saved:"

data/config/routes.rb

@@ -1,8 +1,10 @@
 Manage::Engine.routes.draw do
+  devise_for :admin_users, :class_name => "AdminUser", skip: :registrations, controllers: {
+    sessions: "manage/sessions"
+  }
+
   resources :dashboards
   resources :admin_users
 
-  # devise_for :admin_users, skip: :registrations, controllers: {
-  #   sessions: "manage/sessions",
-  # }
-end
+  root 'dashboards#index'
+end

data/db/migrate/20131204142720_create_admin_users.rb

@@ -0,0 +1,24 @@
+class CreateAdminUsers < ActiveRecord::Migration
+  def change
+    create_table "admin_users", force: true do |t|
+      t.string   "email",                  default: "", null: false
+      t.string   "encrypted_password",     default: "", null: false
+      t.string   "reset_password_token"
+      t.datetime "reset_password_sent_at"
+      t.datetime "remember_created_at"
+      t.integer  "sign_in_count",          default: 0
+      t.datetime "current_sign_in_at"
+      t.datetime "last_sign_in_at"
+      t.string   "current_sign_in_ip"
+      t.string   "last_sign_in_ip"
+      t.integer  "failed_attempts",        default: 0
+      t.string   "unlock_token"
+      t.datetime "locked_at"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    add_index "admin_users", ["email"], name: "index_admin_users_on_email", unique: true, using: :btree
+    add_index "admin_users", ["reset_password_token"], name: "index_admin_users_on_reset_password_token", unique: true, using: :btree
+  end
+end

data/lib/manage/engine.rb

@@ -1,10 +1,21 @@
- require 'kaminari'
- require 'responders'
- require 'inherited_resources'
- require 'zurb-foundation'
+require 'kaminari'
+require 'responders'
+require 'inherited_resources'
+require 'simple_form'
+require 'jquery-rails'
+require 'zurb-foundation'
+require 'devise'
+require 'slim'
+require 'search_object'
 
- module Manage
+module Manage
   class Engine < ::Rails::Engine
     isolate_namespace Manage
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
   end
 end

data/lib/manage/fields/reader.rb

@@ -0,0 +1,57 @@
+module Manage
+  module Fields
+    class Reader
+      class << self
+        def field_value(scope, field_data)
+          current_field, rest_field_parts, custom_query, custom_format = _parse_field_data(field_data)
+          value = scope.public_send(current_field)
+
+          if _is_field_relation?(value)
+            value = custom_query.present? ? custom_query.call(value) : value
+
+            value.map do |entity|
+              ("<a href=\"#{current_field}/#{entity.id}\">#{custom_format.present? ? custom_format.call(entity) : entity.id }</a>")
+            end.join(', ').html_safe
+          else
+            rest_field_parts.empty? ? value : field_value(value, rest_field_parts.join('.'))
+          end
+        end
+
+        def field_title(resource_class, field_data, prefix='')
+          current_field, rest_field_parts = _parse_field_data(field_data)
+          title = resource_class.human_attribute_name(current_field)
+
+          rest_field_parts.empty? ? prefix + title : field_title(resource_class, rest_field_parts.join('.'), prefix + title + ' ')
+        end
+
+        private
+        def _is_field_relation?(field_value)
+          field_value.is_a?(ActiveRecord::Associations::CollectionProxy)
+        end
+
+        def _parse_field_data(field_data)
+          custom_query = nil
+          custom_format = nil
+
+          if field_data.is_a?(Hash)
+            current_field = field_data.keys.first
+            rest_field_parts = field_data[current_field]
+
+            if rest_field_parts.is_a?(String)
+              rest_field_parts = Array(rest_field_parts)
+            else
+              custom_query = field_data[current_field][:query]
+              custom_format = field_data[current_field][:format]
+              rest_field_parts = []
+            end
+          else
+            current_field, *rest_field_parts = field_data.to_s.split('.')
+          end
+
+          return current_field, rest_field_parts, custom_query, custom_format
+        end
+
+      end
+    end
+  end
+end

data/lib/manage/fields/searcher.rb

@@ -0,0 +1,48 @@
+module Manage
+  module Fields
+    class Searcher
+      class << self
+        def generate_search_object(resource_class, search_fields)
+          search_class = Class.new do
+            include SearchObject.module(:model, :sorting)
+
+            def escape_search_term(term)
+              "%#{term.gsub(/\s+/, '%')}%"
+            end
+
+            def parse_date(date)
+              Date.strptime(date, '%Y-%m-%d') rescue nil
+            end
+          end
+
+
+          search_class.scope { resource_class.all }
+          Object.const_set("#{resource_class.name + 'Searcher'}", search_class)
+
+          search_fields.select {|f| not f.to_s.include?('.')}.each do |field|
+            field_type = resource_class.columns_hash[field.to_s].type
+            if field_type == :text or field_type == :string
+              search_class.option field.to_sym do |scope, value|
+                scope.where "#{field.to_s} LIKE ?", escape_search_term(value)
+              end
+            elsif field_type == :datetime
+              search_class.option field.to_sym do |scope, value|
+                date = parse_date value
+                scope.where("DATE(#{field.to_s}) >= ?", date) if date.present?
+              end
+            elsif field_type == :integer
+              search_class.option field.to_sym
+            else
+              search_class.option field.to_sym do |scope, value|
+                scope.where "#{field.to_s} LIKE ?", escape_search_term(value)
+              end
+            end
+          end
+
+          search_class
+        end
+      end
+    end
+  end
+end
+

data/lib/manage/fields.rb

@@ -0,0 +1,6 @@
+module Manage
+  module Fields
+    autoload :Reader, 'manage/fields/reader'
+    autoload :Searcher, 'manage/fields/searcher'
+  end
+end

data/lib/manage/version.rb

@@ -1,3 +1,3 @@
 module Manage
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/manage.rb

@@ -1,3 +1,5 @@
 require "manage/engine"
+require "manage/fields"
+
 module Manage
 end

data/lib/tasks/manage_tasks.rake

@@ -2,3 +2,14 @@
 # task :manage do
 #   # Task goes here
 # end
+
+namespace :manage do
+  desc "Create the initial admin user for the interface"
+  task :create_admin => :environment do
+    user = Manage::AdminUser.create!(
+      :email => "admin@admin.com", 
+      :password => "11223344", 
+      :password_confirmation => "11223344"
+    )
+  end
+end

data/lib/templates/erb/scaffold/_form.html.erb

@@ -2,7 +2,7 @@
   <%%= f.error_notification %>
 
   <div class="form-inputs">
-  <%- attributes.each do |attribute| -%>
+  <%- edit_attributes.each do |attribute| -%>
     <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
   <%- end -%>
   </div>

data/spec/controllers/manage/resource_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Manage
+
+  describe PostsController do
+    render_views
+    routes { Manage::Engine.routes }
+
+    before do
+      @admin = AdminUser.create!(email: 'admin@some.gf', password: '11223344', password_confirmation: '11223344')
+      sign_in @admin
+
+      @user = User.create!(email: 'some@do.cd', username: 'Sandokan')
+      @user.posts.create(content: 'Some')
+      @user.save!
+    end
+
+    it 'Shows only index fields listed' do
+      get :index
+      body = response.body
+
+      body.should include(@user.email)
+      body.should include(@user.username)
+      body.should include(@user.posts.first.id.to_s)
+      body.should include(@user.posts.first.content)
+    end
+  end
+end
+

data/spec/dummy/app/controllers/manage/posts_controller.rb

@@ -0,0 +1,4 @@
+class Manage::PostsController < Manage::ResourceController
+  index_fields :id, 'content', 'user.username', 'user.email'
+  edit_fields :content
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+
+  has_many :posts, dependent: :destroy
+
+end

data/{test → spec}/dummy/config/application.rb

@@ -18,6 +18,7 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
+    I18n.enforce_available_locales = false
   end
 end
 

data/{test → spec}/dummy/config/database.yml

@@ -14,7 +14,7 @@ development:
 # Do not set this db to the same as development or production.
 test:
   adapter: sqlite3
-  database: db/test.sqlite3
+  database: ":memory:"
   pool: 5
   timeout: 5000
 

data/spec/dummy/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+
+  mount Manage::Engine => "/manage"
+
+  Manage::Engine.routes.draw do
+    resources :users
+    resources :posts
+  end
+
+end

data/spec/dummy/db/migrate/20130716083410_init_migration.rb

@@ -0,0 +1,21 @@
+class InitMigration < ActiveRecord::Migration
+  def change
+
+    create_table "posts", force: true do |t|
+      t.text     "content"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.integer  "user_id"
+    end
+
+    add_index "posts", ["user_id"]
+
+    create_table "users", force: true do |t|
+      t.string   "username"
+      t.string   "email", null: false
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+  end
+
+end