openstax_utilities 2.0.0 → 2.1.0

data/spec/lib/openstax/utilities/controller_extensions_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module OpenStax
+  module Utilities
+    
+    describe ControllerExtensions do
+
+      it 'adds get_model to controllers' do
+
+        expect(ApplicationController.new).to respond_to(:get_model)
+
+        expect(UsersController.new).to respond_to(:get_model)
+
+      end
+
+      it 'adds require_restful_actions_allowed! to controllers' do
+
+        expect(ApplicationController).to(
+          respond_to(:require_restful_actions_allowed!))
+
+        expect(UsersController).to respond_to(:require_restful_actions_allowed!)
+
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/openstax/utilities/extended_controller_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+    
+describe UsersController, :type => :controller do
+
+  let!(:user) { User.create }
+
+  before(:all) do
+    UsersController.require_restful_actions_allowed!
+    OSU::AccessPolicy.register(User, DummyAccessPolicy)
+  end
+
+  context 'when user visits restful actions' do
+
+    it 'returns the correct resource with get_model' do
+      controller.current_user = user
+
+      get :new
+      expect(controller.get_model).to be_instance_of(User)
+      expect(controller.get_model.id).to be_nil
+
+      get :show, :id => user.id
+      expect(controller.get_model).to eq(user)
+
+      get :new, :user_id => user.id
+      expect(controller.get_model(:user_id)).to eq(user)
+    end
+
+    it 'calls AccessPolicy with the expected arguments' do
+      controller.current_user = user
+
+      DummyAccessPolicy.last_action = nil
+      DummyAccessPolicy.last_requestor = nil
+      DummyAccessPolicy.last_resource = nil
+
+      get :index
+
+      expect(DummyAccessPolicy.last_action).to be_nil
+      expect(DummyAccessPolicy.last_requestor).to be_nil
+      expect(DummyAccessPolicy.last_resource).to be_nil
+
+      get :show, :id => user.id
+
+      expect(DummyAccessPolicy.last_action).to eq(:read)
+      expect(DummyAccessPolicy.last_requestor).to eq(user)
+      expect(DummyAccessPolicy.last_resource).to eq(user)
+
+      get :new
+
+      expect(DummyAccessPolicy.last_action).to eq(:create)
+      expect(DummyAccessPolicy.last_requestor).to eq(user)
+      expect(DummyAccessPolicy.last_resource).to be_instance_of(User)
+      expect(DummyAccessPolicy.last_resource.id).to be_nil
+
+      post :create, :user => user.attributes
+
+      expect(DummyAccessPolicy.last_action).to eq(:create)
+      expect(DummyAccessPolicy.last_requestor).to eq(user)
+      expect(DummyAccessPolicy.last_resource).to be_instance_of(User)
+      expect(DummyAccessPolicy.last_resource.id).to be_nil
+
+      get :edit, :id => user.id, :user => user.attributes
+
+      expect(DummyAccessPolicy.last_action).to eq(:update)
+      expect(DummyAccessPolicy.last_requestor).to eq(user)
+      expect(DummyAccessPolicy.last_resource).to eq(user)
+
+      put :update, :id => user.id, :user => user.attributes
+
+      expect(DummyAccessPolicy.last_action).to eq(:update)
+      expect(DummyAccessPolicy.last_requestor).to eq(user)
+      expect(DummyAccessPolicy.last_resource).to eq(user)
+
+      delete :destroy, :id => user.id
+
+      expect(DummyAccessPolicy.last_action).to eq(:destroy)
+      expect(DummyAccessPolicy.last_requestor).to eq(user)
+      expect(DummyAccessPolicy.last_resource).to eq(user)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,44 @@ dependencies:
   name: attribeautiful
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.0.7
+- !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: 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'
 description: Utilities for OpenStax web sites
 email:
 - jps@kindlinglabs.com
@@ -57,6 +85,7 @@ files:
 - app/views/osu/shared/_table_cell.html.erb
 - app/views/osu/shared/_table_row.html.erb
 - lib/openstax/utilities/access.rb
+- lib/openstax/utilities/access_policy.rb
 - lib/openstax/utilities/action_list.rb
 - lib/openstax/utilities/active_record_extensions.rb
 - lib/openstax/utilities/acts_as_numberable.rb
@@ -66,6 +95,7 @@ files:
 - lib/openstax/utilities/blocks/table_cell_block.rb
 - lib/openstax/utilities/blocks/table_row_block.rb
 - lib/openstax/utilities/classy_helper.rb
+- lib/openstax/utilities/controller_extensions.rb
 - lib/openstax/utilities/delegate_access_control.rb
 - lib/openstax/utilities/engine.rb
 - lib/openstax/utilities/enum.rb
@@ -82,35 +112,49 @@ files:
 - lib/openstax/utilities/text.rb
 - lib/openstax/utilities/version.rb
 - lib/openstax_utilities.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
+- spec/dummy/README.md
+- spec/dummy/Rakefile
+- spec/dummy/app/access_policies/dummy_access_policy.rb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/assets/stylesheets/scaffold.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/users/_form.html.erb
+- spec/dummy/app/views/users/edit.html.erb
+- spec/dummy/app/views/users/index.html.erb
+- spec/dummy/app/views/users/new.html.erb
+- spec/dummy/app/views/users/show.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/0_create_users.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/lib/openstax/utilities/access_policy_spec.rb
+- spec/lib/openstax/utilities/controller_extensions_spec.rb
+- spec/lib/openstax/utilities/extended_controller_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/openstax/openstax_utilities
 licenses:
 - MIT
@@ -136,32 +180,46 @@ signing_key:
 specification_version: 4
 summary: Utilities for OpenStax web sites
 test_files:
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
+- spec/dummy/app/access_policies/dummy_access_policy.rb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/assets/stylesheets/scaffold.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/users/_form.html.erb
+- spec/dummy/app/views/users/edit.html.erb
+- spec/dummy/app/views/users/index.html.erb
+- spec/dummy/app/views/users/new.html.erb
+- spec/dummy/app/views/users/show.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/migrate/0_create_users.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/Rakefile
+- spec/dummy/README.md
+- spec/dummy/script/rails
+- spec/lib/openstax/utilities/access_policy_spec.rb
+- spec/lib/openstax/utilities/controller_extensions_spec.rb
+- spec/lib/openstax/utilities/extended_controller_spec.rb
+- spec/spec_helper.rb

data/test/dummy/README.rdoc

@@ -1,261 +0,0 @@
-== Welcome to Rails
-
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
-
-This pattern splits the view (also called the presentation) into "dumb"
-templates that are primarily responsible for inserting pre-built data in between
-HTML tags. The model contains the "smart" domain objects (such as Account,
-Product, Person, Post) that holds all the business logic and knows how to
-persist themselves to a database. The controller handles the incoming requests
-(such as Save New Account, Update Product, Show Post) by manipulating the model
-and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting Started
-
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
-
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
-
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
-
-* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
-* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files. Have "tail -f" commands
-running on the server.log and development.log. Rails will automatically display
-debugging and runtime information to these files. Debugging info will also be
-shown in the browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code
-using the Ruby logger class from inside your controllers. Example:
-
-  class WeblogController < ActionController::Base
-    def destroy
-      @weblog = Weblog.find(params[:id])
-      @weblog.destroy
-      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
-    end
-  end
-
-The result will be a message in your log file along the lines of:
-
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
-
-More information on how to use the logger is at http://www.ruby-doc.org/core/
-
-Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
-several books available online as well:
-
-* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
-* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
-
-These two books will bring you up to speed on the Ruby language and also on
-programming in general.
-
-
-== Debugger
-
-Debugger support is available through the debugger command when you start your
-Mongrel or WEBrick server with --debugger. This means that you can break out of
-execution at any point in the code, investigate and change the model, and then,
-resume execution! You need to install ruby-debug to run the server in debugging
-mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.all
-      debugger
-    end
-  end
-
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8
-          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
-       #<Post:0x14a6620
-          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
-  >> @posts.first.title = "hello from a debugger"
-  => "hello from a debugger"
-
-...and even better, you can examine how your runtime objects actually work:
-
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you can enter "cont".
-
-
-== Console
-
-The console is a Ruby shell, which allows you to interact with your
-application's domain model. Here you'll have all parts of the application
-configured, just like it is when the application is running. You can inspect
-domain models, change values, and save to the database. Starting the script
-without arguments will launch it in the development environment.
-
-To start the console, run <tt>rails console</tt> from the application
-directory.
-
-Options:
-
-* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
-  made to the database.
-* Passing an environment name as an argument will load the corresponding
-  environment. Example: <tt>rails console production</tt>.
-
-To reload your controllers and models after launching the console run
-<tt>reload!</tt>
-
-More information about irb can be found at:
-link:http://www.rubycentral.org/pickaxe/irb.html
-
-
-== dbconsole
-
-You can go to the command line of your database directly through <tt>rails
-dbconsole</tt>. You would be connected to the database with the credentials
-defined in database.yml. Starting the script without arguments will connect you
-to the development database. Passing an argument will connect you to a different
-database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
-PostgreSQL and SQLite 3.
-
-== Description of Contents
-
-The default directory structure of a generated Ruby on Rails application:
-
-  |-- app
-  |   |-- assets
-  |       |-- images
-  |       |-- javascripts
-  |       `-- stylesheets
-  |   |-- controllers
-  |   |-- helpers
-  |   |-- mailers
-  |   |-- models
-  |   `-- views
-  |       `-- layouts
-  |-- config
-  |   |-- environments
-  |   |-- initializers
-  |   `-- locales
-  |-- db
-  |-- doc
-  |-- lib
-  |   `-- tasks
-  |-- log
-  |-- public
-  |-- script
-  |-- test
-  |   |-- fixtures
-  |   |-- functional
-  |   |-- integration
-  |   |-- performance
-  |   `-- unit
-  |-- tmp
-  |   |-- cache
-  |   |-- pids
-  |   |-- sessions
-  |   `-- sockets
-  `-- vendor
-      |-- assets
-          `-- stylesheets
-      `-- plugins
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/assets
-  Contains subdirectories for images, stylesheets, and JavaScript files.
-
-app/controllers
-  Holds controllers that should be named like weblogs_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ApplicationController which itself descends from ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb. Models descend from
-  ActiveRecord::Base by default.
-
-app/views
-  Holds the template files for the view that should be named like
-  weblogs/index.html.erb for the WeblogsController#index action. All views use
-  eRuby syntax by default.
-
-app/views/layouts
-  Holds the template files for layouts to be used with views. This models the
-  common header/footer method of wrapping views. In your views, define a layout
-  using the <tt>layout :default</tt> and create a file named default.html.erb.
-  Inside default.html.erb, call <% yield %> to render the view using this
-  layout.
-
-app/helpers
-  Holds view helpers that should be named like weblogs_helper.rb. These are
-  generated for you automatically when using generators for controllers.
-  Helpers can be used to wrap functionality for your views into methods.
-
-config
-  Configuration files for the Rails environment, the routing map, the database,
-  and other dependencies.
-
-db
-  Contains the database schema in schema.rb. db/migrate contains all the
-  sequence of Migrations for your schema.
-
-doc
-  This directory is where your application documentation will be stored when
-  generated using <tt>rake doc:app</tt>
-
-lib
-  Application specific libraries. Basically, any kind of custom code that
-  doesn't belong under controllers, models, or helpers. This directory is in
-  the load path.
-
-public
-  The directory available for the web server. Also contains the dispatchers and the
-  default HTML files. This should be set as the DOCUMENT_ROOT of your web
-  server.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures. When using the rails generate
-  command, template test files will be generated for you and placed in this
-  directory.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins
-  subdirectory. If the app has frozen rails, those gems also go here, under
-  vendor/rails/. This directory is in the load path.

data/test/dummy/config/routes.rb

@@ -1,4 +0,0 @@
-Rails.application.routes.draw do
-
-  mount OpenstaxUtilities::Engine => "/openstax_utilities"
-end

data/test/integration/navigation_test.rb

@@ -1,10 +0,0 @@
-require 'test_helper'
-
-class NavigationTest < ActionDispatch::IntegrationTest
-  fixtures :all
-
-  # test "the truth" do
-  #   assert true
-  # end
-end
-