eaco 0.6.1 → 0.7.0

data/lib/eaco/controller.rb

@@ -1,8 +1,9 @@
 begin
   require 'active_support/concern'
 rescue LoadError
-  # This is falsely true during specs ran by Guard. FIXME.
+  # :nocov: This is falsely true during specs ran by Guard. FIXME.
   abort 'Eaco::Controller requires activesupport. Please add it to Gemfile.'
+  # :nocov:
 end
 
 module Eaco
@@ -59,7 +60,14 @@ module Eaco
       end
 
       ##
-      # @return [Symbol] the permission required to access the given action.
+      # Gets the permission required to access the given +action+, falling
+      # back on the default +:all+ action, or +nil+ if no permission is
+      # defined.
+      #
+      # @return [Symbol] the required permission or nil
+      #
+      # @see {Eaco::Resource}
+      # @see {Eaco::DSL::Resource}
       #
       def permission_for(action)
         authorization_permissions[action] || authorization_permissions[:all]
@@ -67,7 +75,12 @@ module Eaco
 
       protected
         ##
-        # Permission requirements configured on this controller.
+        # Permission requirements configured on this controller, keyed by
+        # permission symbol and with role symbols as values.
+        #
+        # @return [Hash]
+        #
+        # @see {Eaco::DSL::Resource}
         #
         def authorization_permissions
           @_authorization_permissions ||= {}

data/lib/eaco/coverage.rb

@@ -0,0 +1,83 @@
+require 'coveralls'
+require 'simplecov'
+require 'eaco/rake'
+
+module Eaco
+
+  ##
+  # Integration with code coverage tools.
+  #
+  # Loading this module will start collecting coverage data.
+  #
+  module Coverage
+    extend self
+
+    ##
+    # Starts collecting coverage data.
+    #
+    # @return [nil]
+    #
+    def start!
+      Coveralls.wear_merged!(&simplecov_configuration)
+
+      nil
+    end
+
+    ##
+    # Reports coverage data to the remote service
+    #
+    # @return [nil]
+    #
+    def report!
+      simplecov
+      Coveralls.push!
+
+      nil
+    end
+
+    ##
+    # Formats coverage results using the default formatter.
+    #
+    # @return [String] Coverage summary
+    #
+    def format!
+      Rake::Utils.capture_stdout do
+        result && result.format!
+      end.strip
+    end
+
+    private
+
+    ##
+    # The coverage result
+    #
+    # @return [SimpleCov::Result]
+    #
+    def result
+      simplecov.result
+    end
+
+    ##
+    # Configures simplecov using {.simplecov_configuration}
+    #
+    # @return [Class] +SimpleCov+
+    #
+    def simplecov
+      SimpleCov.configure(&simplecov_configuration)
+    end
+
+    ##
+    # Configures +SimpleCov+ to use a different directory
+    # for each different appraisal +Gemfile+.
+    #
+    # @return [Proc] a +SimpleCov+ configuration block.
+    #
+    def simplecov_configuration
+      proc do
+        gemfile = Eaco::Rake::Utils.gemfile
+        coverage_dir "coverage/#{gemfile}"
+      end
+    end
+  end
+
+end

data/lib/eaco/cucumber/active_record.rb

@@ -1,7 +1,9 @@
 begin
   require 'active_record'
 rescue LoadError
+  # :nocov:
   abort "ActiveRecord requires the rails appraisal. Try `appraisal cucumber`"
+  # :nocov:
 end
 
 require 'yaml'
@@ -58,15 +60,6 @@ module Eaco
         active_record.logger
       end
 
-      ##
-      # @return [ActiveRecord::Connection] the current +ActiveRecord+ connection
-      # object.
-      #
-      def connection
-        active_record.connection
-      end
-      alias adapter connection
-
       ##
       # Returns an Hash wit the database configuration.
       #
@@ -80,9 +73,11 @@ module Eaco
       def configuration
         @_config ||= YAML.load(config_file.read).tap do |conf|
           def conf.to_s
+            # :nocov:
             'pgsql://%s:%s@%s/%s' % values_at(
               :username, :password, :hostname, :database
             )
+            # :nocov:
           end
         end
       end
@@ -104,6 +99,7 @@ module Eaco
         Pathname.new('features/active_record.yml').realpath
 
       rescue Errno::ENOENT => error
+        # :nocov:
         raise error.class.new, <<-EOF.squeeze(' ')
 
           #{error.message}.
@@ -112,6 +108,7 @@ module Eaco
           default location, or specify your configuration file location by
           passing the `EACO_AR_CONFIG' environment variable.
         EOF
+        # :nocov:
       end
 
       ##
@@ -143,23 +140,21 @@ module Eaco
       protected
 
       ##
-      # Captures stdout and logs it
+      # Captures stdout emitted by the given +block+ and logs it
+      # as +info+ messages.
       #
+      # @param block [Proc]
       # @return [nil]
+      # @see {Rake::Utils.capture_stdout}
       #
-      def log_stdout
-        stdout, string = $stdout, StringIO.new
-        $stdout = string
-
-        yield
+      def log_stdout(&block)
+        stdout = Rake::Utils.capture_stdout(&block)
 
-        string.tap(&:rewind).read.split("\n").each do |line|
+        stdout.split("\n").each do |line|
           logger.info line
         end
 
         nil
-      ensure
-        $stdout = stdout
       end
     end
 

data/lib/eaco/cucumber/active_record/department.rb

@@ -12,6 +12,10 @@ module Eaco
       # @see Eaco::Cucumber::World
       #
       class Department < ::ActiveRecord::Base
+        has_many :positions
+        has_many :users, through: :positions
+
+        validates :name, uniqueness: true
       end
 
     end

data/lib/eaco/cucumber/active_record/position.rb

@@ -14,6 +14,8 @@ module Eaco
       class Position < ::ActiveRecord::Base
         belongs_to :user
         belongs_to :department
+
+        validates :user, :department, presence: :true
       end
 
     end

data/lib/eaco/cucumber/active_record/schema.rb

@@ -2,6 +2,18 @@ module Eaco
   module Cucumber
     module ActiveRecord
 
+      # @!method clean
+      #
+      # Drops all tables currently instantiated in the database.
+      #
+      # @see Eaco::Cucumber::World
+      #
+      ::ActiveRecord::Base.connection.tap do |connection|
+        connection.tables.each do |table_name|
+          connection.drop_table table_name
+        end
+      end
+
       # @!method schema
       #
       # Defines the database schema for the {Eaco::Cucumber::World} scenario.
@@ -9,21 +21,27 @@ module Eaco
       # @see Eaco::Cucumber::World
       #
       ::ActiveRecord::Schema.define(version: '2015022301') do
+        # Resource
         create_table 'documents', force: true do |t|
           t.string :name
           t.column :acl, :jsonb
         end
 
+        # Actor
         create_table 'users', force: true do |t|
           t.string :name
+          t.boolean :admin, default: false
         end
 
+        # Designator source
         create_table 'departments', force: true do |t|
-          t.string :abbr
+          t.string :name
         end
+        add_index :departments, :name, unique: true
 
+        # Designator source
         create_table 'positions', force: true do |t|
-          t.string :job_title
+          t.string :name
 
           t.references :user
           t.references :department

data/lib/eaco/cucumber/active_record/user.rb

@@ -17,6 +17,15 @@ module Eaco
 
         has_many :positions
         has_many :departments, through: :positions
+
+        ##
+        # The {Department} names this User has a {Position} in.
+        #
+        # @return [Array] the {Department} names as +String+s.
+        #
+        def department_names
+          departments.to_set(&:name)
+        end
       end
 
     end

data/lib/eaco/cucumber/active_record/user/designators.rb

@@ -9,7 +9,10 @@ module Eaco
         # @see World
         #
         module Designators
-          autoload :User, 'eaco/cucumber/active_record/user/designators/user.rb'
+          autoload :Authenticated, 'eaco/cucumber/active_record/user/designators/authenticated.rb'
+          autoload :Department,    'eaco/cucumber/active_record/user/designators/department.rb'
+          autoload :Position,      'eaco/cucumber/active_record/user/designators/position.rb'
+          autoload :User,          'eaco/cucumber/active_record/user/designators/user.rb'
         end
 
       end

data/lib/eaco/cucumber/active_record/user/designators/authenticated.rb

@@ -0,0 +1,54 @@
+module Eaco
+  module Cucumber
+    module ActiveRecord
+      class User
+        module Designators
+
+          ##
+          # A {Designator} based on a the {User} class.
+          #
+          # This is an example on how to grant rights to all instances
+          # of a given model.
+          #
+          # The class name is available as the {Designator#value}.
+          #
+          # The String representation for an example User is
+          # +"authenticated:User"+.
+          #
+          class Authenticated < Eaco::Designator
+            label "Any user"
+
+            ##
+            # This {Designator} description.
+            #
+            # @return [String] an hardcoded description
+            #
+            def describe(*)
+              "Any authenticated user"
+            end
+
+            ##
+            # {User}s matching this designator.
+            #
+            # @return [Array] All {User}s.
+            #
+            def resolve
+              klass.all
+            end
+
+            private
+              ##
+              # Looks up this class by constantizing it.
+              #
+              # @return [Class]
+              #
+              def klass
+                @_klass ||= self.value.constantize
+              end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eaco/cucumber/active_record/user/designators/department.rb

@@ -0,0 +1,58 @@
+module Eaco
+  module Cucumber
+    module ActiveRecord
+      class User
+        module Designators
+
+          ##
+          # A {Designator} based on a the {Department} an {User} occupies
+          # a {Position} in. It resolves {Actor}s by id looking them up
+          # through the {Position} model.
+          #
+          # As {Department}s have unique names, their name instead of
+          # their ID is used in this example.
+          #
+          # The Department name is available as the {Designator#value}.
+          #
+          # The String representation for an example ICT Department is
+          # +"department:ICT"+.
+          #
+          class Department < Eaco::Designator
+            ##
+            # This {Designator} description.
+            #
+            # @return [String] the {Department} name, such as ICT or COM
+            #                  or EXE or BAT.
+            #
+            def describe(*)
+              department.name
+            end
+
+            ##
+            # {User}s matching this designator.
+            #
+            # @return [Array] all users currently occupying a position in
+            #                 this Department
+            #
+            def resolve
+              department.users
+            end
+
+            private
+              ##
+              # Looks up this Department by name, and memoizes it in an
+              # instance variable.
+              #
+              # @return [ActiveRecord::Department] the referenced department
+              #
+              def department
+                @_department ||= ActiveRecord::Department.
+                  where(name: self.value).first!
+              end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eaco/cucumber/active_record/user/designators/position.rb

@@ -0,0 +1,53 @@
+module Eaco
+  module Cucumber
+    module ActiveRecord
+      class User
+        module Designators
+
+          ##
+          # A {Designator} based on a position an {User} occupies in an
+          # organigram. It resolves {Actor}s by id looking them up from
+          # the +user_id+ field.
+          #
+          # The Position ID is available as the {Designator#value}.
+          #
+          # The String representation for an example Position 42 is
+          # +"position:42"+.
+          #
+          class Position < Eaco::Designator
+            ##
+            # This {Designator} description.
+            #
+            # @return [String] the {Position} name, such as "Manager" or
+            #                  or "Systems Analyst" or "Consultant".
+            #
+            def describe(*)
+              "#{position.name} in #{position.department.name}"
+            end
+
+            ##
+            # {User}s matching this designator.
+            #
+            # @return [Array] the user currently occupying this Position.
+            #
+            def resolve
+              [position.user]
+            end
+
+            private
+              ##
+              # Looks up this position by ID, and memoizes it in an instance
+              # variable.
+              #
+              # @return [ActiveRecord::Position] the referenced Position.
+              #
+              def position
+                @_position ||= ActiveRecord::Position.find(self.value)
+              end
+          end
+
+        end
+      end
+    end
+  end
+end