openstax_utilities 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yzc2ZjE5YTExNmU0YjkzYWRmMTgwYzQyYjJjOWYzMDE5Nzk2OWI4ZQ==
+  data.tar.gz: !binary |-
+    NDdhMjA5NDJiOWM4YmM3MzNiNWE2NWE3Nzk5ZmRlYzJiY2FlOTZhOA==
+SHA512:
+  metadata.gz: !binary |-
+    MzI4MzM2MDBlN2U2MmNiYzU1ODk3NTA5NmExOWJlZTkyOTdhOGQ0OGQxNWMx
+    Nzg5Y2UxNDNhOTc5NWFkYzIwMDkzZDI5YjRjNzcwMWNiOWRlYWY2YjExMDE5
+    YTViOWUzZTY5NDRiZDFmODJjZGY5MjllOGMxZmY4ZDJhNmM0NmY=
+  data.tar.gz: !binary |-
+    N2NjNWY2MTQzMDNmZjRiMTYxM2U0MzQ4NTQxMzQ5Y2Q2MDdiYWQ4YzA4OTc4
+    ZGEzODA2YTdiYmY5ZTlhNGE0MDhmNjk1NjFjNDVmYTkzOGU5MDRlMjQ3NzFi
+    ZjRjMWFiNGUwZDg5Y2RmMDhlNGFjZTk3MWQwNWMwMDQ5ZTg2MzI=

data/app/helpers/openstax/utilities/osu_helper.rb

@@ -3,6 +3,7 @@ module OpenStax::Utilities
 
     def osu
       @@osu_class ||= Class.new(ClassyHelper) do
+        include OpenStax::Utilities::Helpers::Misc
         include OpenStax::Utilities::Helpers::Blocks
         include OpenStax::Utilities::Helpers::Partials
         include OpenStax::Utilities::Helpers::ActionList

data/lib/openstax/utilities/active_record_extensions.rb

@@ -0,0 +1,14 @@
+module ActiveRecord
+  class Base
+       
+    def self.find_in_specified_order(ids)
+      items = find(ids)
+
+      order_hash = {}
+      ids.each_with_index {|id, index| order_hash[id.to_i]=index}
+
+      items.sort_by!{|item| order_hash[item.id]}
+    end
+    
+  end
+end

data/lib/openstax/utilities/acts_as_numberable.rb

@@ -0,0 +1,218 @@
+# Copyright 2011-2012 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module OpenStax
+  module Utilities
+
+    module ActsAsNumberable
+
+      # Adds code to an ActiveRecord object so that it can be sorted.
+      # @example Model is ordered globally using a 'number' field
+      #   class MyModel < ActiveRecord::Base
+      #     acts_as_numberable
+      # @example Model is ordered globally using a 'position' field
+      #   class MyModel < ActiveRecord::Base
+      #     acts_as_numberable :number_field => :position
+      # @example Model is ordered within a container class using a position field
+      #   class MyModel < ActiveRecord::Base
+      #     belongs_to :other_model
+      #     acts_as_numberable :container => :other_model,
+      #                        :number_field => :position
+      # @param :container The relationship that contains this model in an order.
+      #   Note that this code assumes the foreign key for this container is found
+      #   by appending "_id" onto the container name, which might not always be the
+      #   case.
+      # @param :number_field The column to use as the sorting number, given either
+      #   as a string or a symbol.  The default is 'number'
+      # @param :table_class By default this code assumes that the database table
+      #   name to use for this model can be derived from the model's class name; in 
+      #   some cases (e.g. STI) this is not the case and this parameter can be used
+      #   to manually specify the class from which to derive the database table name.
+      #
+      def acts_as_numberable(options={})
+        configuration = {}
+        configuration.update(options) if options.is_a?(Hash)
+       
+        container_column = nil
+        container_column_symbol = nil
+
+        # When calling assign_number below, you normally want to run a query against
+        # self.class to figure out what the next available number is; however, if the 
+        # class acting as numberable is using STI, self.class will return the child class
+        # which is likely not what we want.  In these cases, we can specify the base
+        # class here (the class that has the same name as the DB table) so that it is used
+        # instead.
+        table_class = configuration[:table_class]
+
+        number_field = (configuration[:number_field] || 'number').to_s
+        
+        if !configuration[:container].nil?
+          container_column = configuration[:container].to_s + "_id"
+          container_column_symbol = configuration[:container].to_sym
+        end
+        
+        uniqueness_scope_string = container_column.nil? ? "" : ":scope => :#{container_column},"
+       
+        class_eval <<-EOV
+          include ActsAsNumberable::BasicInstanceMethods
+        
+          before_validation :assign_number, :on => :create
+          
+          validates :#{number_field}, :uniqueness => { #{uniqueness_scope_string}
+                                                       :allow_nil => true},
+                                      :numericality => { :only_integer => true, 
+                                                         :greater_than_or_equal_to => 0,
+                                                         :allow_nil => true }    
+
+          
+          after_destroy :mark_as_destroyed
+          
+          attr_accessor :destroyed
+          attr_accessor :changed_sets
+
+          attr_protected :#{number_field}
+        
+          scope :ordered, order('#{number_field} ASC')
+          scope :reverse_ordered, order('#{number_field} DESC')
+          
+          def self.sort!(sorted_ids)
+            return if sorted_ids.blank?
+            items = []
+            ActiveRecord::Base.transaction do
+              items = find_in_specified_order(sorted_ids)
+              
+              items.each do |item|
+                item.send('#{number_field}=', nil)
+                item.save!
+              end
+              
+              items.each_with_index do |item, ii| 
+                item.send('#{number_field}=', ii)
+                item.save!
+              end
+            end
+            items
+          end
+
+          def table_class
+            #{table_class}
+          end
+
+          def number_field
+            '#{number_field}'
+          end
+        EOV
+       
+       
+        if !configuration[:container].nil?
+          class_eval <<-EOV
+            include ActsAsNumberable::ContainerInstanceMethods
+          
+            # When we had nested acts_as_numberables, there were cases where the
+            # objects were having their numbers changed (as their peers were being
+            # removed from the container), but then when it came time to delete those 
+            # objects they still had their old number.  So just reload before
+            # destroy.
+            before_destroy(prepend: true) {self.reload}
+          
+            after_destroy :remove_from_container!
+          
+            def container_column
+              '#{container_column}'
+            end
+
+            def container
+              '#{configuration[:container]}'
+            end
+
+            def table_class
+              #{table_class}
+            end
+          
+          EOV
+          
+        end
+           
+      end
+       
+      module BasicInstanceMethods
+        protected
+
+        def my_class
+          table_class || self.class
+        end
+
+        def assign_number
+          self.send("#{number_field}=", my_class.count) if self.send("#{number_field}").nil?
+        end
+         
+        def mark_as_destroyed
+          destroyed = true
+        end
+
+        def me_and_peers
+          my_class.scoped
+        end
+      end
+       
+      module ContainerInstanceMethods
+        def move_to_container!(new_container)
+          return if new_container.id == self.send(container_column)
+          ActiveRecord::Base.transaction do
+            remove_from_container!
+
+            self.send container + "=", new_container
+
+            self.assign_number
+            self.save!
+            self.changed_sets = true
+          end
+        end
+
+        def remove_from_container!
+          later_items = my_class.where(container_column => self.send(container_column))
+                                .where("#{number_field} > ?", self.send(number_field))
+
+          if !self.destroyed
+            self.send "#{number_field}=", nil
+            self.send container_column + '=', nil
+            self.save!
+          end
+
+          # Do this to make sure that the reordering below doesn't 
+          # cause a number to be duplicated temporarily (which would
+          # cause a validation error)
+          later_items.sort_by!{|item| item.send(number_field)}
+
+          later_items.each do |later|
+            later.send("#{number_field}=", later.send(number_field)-1)
+            later.save!
+          end
+        end
+        
+        def my_class
+          table_class || self.class
+        end
+
+        def me_and_peers
+          my_class.where(container_column => self.send(container_column))
+        end
+
+        protected
+        
+        def assign_number
+          if self.send(number_field).nil?
+            self.send("#{number_field}=", 
+                      my_class
+                        .where(container_column => self.send(container_column))
+                        .count) 
+          end
+        end
+      end
+      
+    end
+
+  end
+end
+ 
+ActiveRecord::Base.extend OpenStax::Utilities::ActsAsNumberable

data/lib/openstax/utilities/delegate_access_control.rb

@@ -0,0 +1,51 @@
+# Copyright 2011-2012 Rice University. Licensed under the Affero General Public 
+# License version 3 or later.  See the COPYRIGHT file for details.
+
+module OpenStax
+  module Utilities
+
+    module DelegateAccessControl
+
+      # Adds code to an ActiveRecord object to delegate its access control methods to
+      # another object.
+      # @example Model is ordered globally using a 'number' field
+      #   class MyModel < ActiveRecord::Base
+      #     belongs_to :another
+      #     delegate_access_control to: :another
+      # @param :to The relationship to which the access control methods should
+      #   be delegated.
+      # @param :include_sort If true, a "can_be_sorted_by?" method will be included
+      #   (Default: false)
+      #
+      def delegate_access_control(options={})
+        configuration = {include_sort: false}
+        configuration.update(options) if options.is_a?(Hash)
+
+        raise IllegalArgument, "A :to option must be provided" if configuration[:to].blank?
+        
+        configuration[:to] = configuration[:to].to_s
+
+        class_eval <<-EOV
+          delegate :can_be_read_by?, 
+                   :can_be_updated_by?, 
+                   to: :#{configuration[:to]}
+
+          # Delegating creation and destroying of this contained object means you can
+          # update the containing object
+          
+          alias_method :can_be_created_by?, :can_be_updated_by?
+          alias_method :can_be_destroyed_by?, :can_be_updated_by?
+
+          if #{configuration[:include_sort]}
+            alias_method :can_be_sorted_by?, :can_be_updated_by?            
+          end
+        EOV
+
+      end
+       
+    end
+
+  end
+end
+ 
+ActiveRecord::Base.extend OpenStax::Utilities::DelegateAccessControl

data/lib/openstax/utilities/helpers/misc.rb

@@ -0,0 +1,9 @@
+module OpenStax::Utilities::Helpers
+  module Misc
+
+    def tf_to_yn(bool, options={})
+      bool ? "Yes" : "No"
+    end
+
+  end
+end

data/lib/openstax/utilities/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Utilities
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/openstax_utilities.rb

@@ -8,6 +8,7 @@ OSU = OpenStax::Utilities
 require "openstax/utilities/engine"
 require "openstax/utilities/version"
 require "openstax/utilities/exceptions"
+require "openstax/utilities/active_record_extensions"
 require "openstax/utilities/settings"
 require "openstax/utilities/access"
 require "openstax/utilities/enum"
@@ -15,8 +16,11 @@ require "openstax/utilities/ruby"
 require "openstax/utilities/text"
 require "openstax/utilities/network"
 require "openstax/utilities/action_list"
+require "openstax/utilities/acts_as_numberable"
+require "openstax/utilities/delegate_access_control"
 
 require "openstax/utilities/classy_helper"
+require "openstax/utilities/helpers/misc"
 require "openstax/utilities/helpers/blocks"
 require "openstax/utilities/helpers/partials"
 require "openstax/utilities/helpers/action_list"

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: attribeautiful
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -50,6 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
 - app/assets/javascripts/openstax_utilities.js
 - app/assets/stylesheets/openstax_utilities.css
 - app/helpers/openstax/utilities/osu_helper.rb
@@ -60,12 +58,15 @@ files:
 - app/views/osu/shared/_table_row.html.erb
 - lib/openstax/utilities/access.rb
 - lib/openstax/utilities/action_list.rb
+- lib/openstax/utilities/active_record_extensions.rb
+- lib/openstax/utilities/acts_as_numberable.rb
 - lib/openstax/utilities/blocks/block_base.rb
 - lib/openstax/utilities/blocks/section_block.rb
 - lib/openstax/utilities/blocks/table_block.rb
 - 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/delegate_access_control.rb
 - lib/openstax/utilities/development.rb
 - lib/openstax/utilities/engine.rb
 - lib/openstax/utilities/enum.rb
@@ -73,6 +74,7 @@ files:
 - lib/openstax/utilities/helpers/action_list.rb
 - lib/openstax/utilities/helpers/blocks.rb
 - lib/openstax/utilities/helpers/datetime.rb
+- lib/openstax/utilities/helpers/misc.rb
 - lib/openstax/utilities/helpers/partials.rb
 - lib/openstax/utilities/network.rb
 - lib/openstax/utilities/ruby.rb
@@ -80,14 +82,14 @@ files:
 - lib/openstax/utilities/text.rb
 - lib/openstax/utilities/version.rb
 - lib/openstax_utilities.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
+- 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
@@ -103,45 +105,35 @@ files:
 - 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
 homepage: http://github.com/openstax/openstax_utilities
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1961078437370851561
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1961078437370851561
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Utilities for OpenStax web sites
 test_files:
 - test/dummy/app/assets/javascripts/application.js