padrino-admin 0.10.3 → 0.10.4

data/lib/padrino-admin/access_control.rb

@@ -5,13 +5,13 @@ module Padrino
     class AccessControlError < StandardError # @private
     end
     ##
-    # This module give to a padrino application an access control functionality
+    # This module enables access control functionality within a padrino application.
     #
     module AccessControl
-      ##
-      # Method used by Padrino::Application when we register the extension
-      #
       class << self
+        ##
+        # Method used by Padrino::Application when we register the extension
+        #
         def registered(app)
           app.set :session_id, "_padrino_#{File.basename(Padrino.root)}_#{app.app_name}".to_sym
           app.helpers Padrino::Admin::Helpers::AuthenticationHelpers
@@ -23,6 +23,9 @@ module Padrino
         alias :included :registered
       end
 
+      ##
+      # This base access control class where roles are defined as are authorizations.
+      #
       class Base
         def initialize # @private
           @roles, @authorizations, @project_modules = [], [], []
@@ -111,6 +114,9 @@ module Padrino
         end
       end # Base
 
+      ###
+      # Project Authorization Class
+      #
       class Authorization
         attr_reader :allowed, :denied, :project_modules, :roles
 

data/lib/padrino-admin/generators/actions.rb

@@ -1,6 +1,12 @@
 module Padrino
   module Generators
+    ##
+    # Generator action definitions for the admin panel.
+    #
     module Admin
+      ##
+      # Important tasks for setting up or configuring the admin application.
+      #
       module Actions
         ##
         # Tell us which orm we are using

data/lib/padrino-admin/generators/admin_app.rb

@@ -1,14 +1,18 @@
 module Padrino
   module Generators
-
+    ##
+    # Defines the generator for creating a new admin app.
+    #
     class AdminApp < Thor::Group
 
       # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:admin, self)
 
-      # Define the source template root and themes
+      # Define the source template root and themes.
       def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      # Defines the "banner" text for the CLI.
       def self.banner; "padrino-gen admin"; end
+      # Defines the theme names for admin based on available.
       def self.themes; Dir[File.dirname(__FILE__) + "/templates/assets/stylesheets/themes/*"].map { |t| File.basename(t) }.sort; end
 
       # Include related modules

data/lib/padrino-admin/generators/admin_page.rb

@@ -1,6 +1,8 @@
 module Padrino
   module Generators
-
+    ##
+    # Defines the generator for creating a new admin page.
+    #
     class AdminPage < Thor::Group
       attr_accessor :default_orm
 
@@ -9,6 +11,7 @@ module Padrino
 
       # Define the source template root
       def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      # Defines the "banner" text for the CLI.
       def self.banner; "padrino-gen admin_page [model]"; end
 
       # Include related modules

data/lib/padrino-admin/generators/orm.rb

@@ -1,7 +1,15 @@
 module Padrino
   module Admin
+    ##
+    # Contains all admin related generator functionality.
+    #
     module Generators
+      # Defines a generic exception for the admin ORM handler.
       class OrmError < StandardError; end
+
+      ##
+      # Defines the generic ORM management functions used to manipulate data for admin.
+      # @private
       class Orm
         attr_reader :klass_name, :klass, :name_plural, :name_singular, :orm
 

data/lib/padrino-admin/helpers/authentication_helpers.rb

@@ -1,6 +1,9 @@
 module Padrino
   module Admin
     module Helpers
+      ##
+      # Common helpers used for authorization within an application.
+      #
       module AuthenticationHelpers
         ##
         # Returns true if +current_account+ is logged and active.

data/lib/padrino-admin/helpers/view_helpers.rb

@@ -1,6 +1,12 @@
 module Padrino
   module Admin
+    ##
+    # Contains all admin related helpers.
+    #
     module Helpers
+      ##
+      # i18n translation helpers for admin to retrieve words based on locale.
+      #
       module ViewHelpers
         ##
         # Translates a given word for padrino admin

data/lib/padrino-admin/utils/crypt.rb

@@ -2,6 +2,9 @@ require 'openssl'
 
 module Padrino
   module Admin
+    ##
+    # Common utility methods used within the admin application.
+    #
     module Utils
       ##
       # This util it's used for encrypt/decrypt password.

data/lib/padrino-admin.rb

@@ -33,5 +33,5 @@ begin
   require 'padrino-gen'
   Padrino::Generators.load_paths << Dir[File.dirname(__FILE__) + '/padrino-admin/generators/{actions,orm,admin_app,admin_page}.rb']
 rescue LoadError
-
+  # Fail silently
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-admin
 version: !ruby/object:Gem::Version 
-  hash: 49
   prerelease: 
-  segments: 
-  - 0
-  - 10
-  - 3
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors: 
 - Padrino Team
@@ -18,8 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 -07:00
-default_executable: 
+date: 2011-10-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: padrino-core
@@ -29,12 +23,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 10
-        - 3
-        version: 0.10.3
+        version: 0.10.4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -45,12 +34,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 10
-        - 3
-        version: 0.10.3
+        version: 0.10.4
   type: :runtime
   version_requirements: *id002
 description: Admin View for Padrino applications
@@ -171,7 +155,6 @@ files:
 - test/helper.rb
 - test/test_admin_application.rb
 - test/test_locale.rb
-has_rdoc: true
 homepage: http://www.padrinorb.com
 licenses: []
 
@@ -185,25 +168,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: padrino-admin
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Admin Dashboard for Padrino