ccls-common_lib 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8c50afcfe26dbc472a15bc46ddd629a621affcf
+  data.tar.gz: 25823f20452eb8cc8fe48810145b5b39bb87f87a
+SHA512:
+  metadata.gz: 301a729ed0c807e32fe0b8be0dbb5fe46a892ae46be1052df6f2fdf0bba8392494631b134568dc7f81731b9512eb8dfc8025455ee1b80c528d98ea4433eb258e
+  data.tar.gz: 332d0f121b509fa9b39ef8657c0ffae321b9746abd33b2bd49c1daf1b0cb5ebfa66694f78113a0df991f4bb393d1630b43017035dfeb347d9fc2d140b0ec92a5

data/README.rdoc

@@ -0,0 +1,116 @@
+= CCLS Common Lib
+
+After further pondering, I think that I'm just going to fork all of the jakewendt repo/gems into ccls and then to use the ccls-* gem instead.
+
+I've included ruby_extension and rails_extension.  Working on simply_helpful.  Next up will be simply_authorized.
+
+Some of these extensions and additions are not actually used on any of the CCLS sites, but were part of my original gems.
+There existance should not cause any problems.
+
+---
+
+This ruby gem ( ccls-common_lib ) is meant to include all of the current functionality provided by ...
+
+* {ccls-ruby_extension}[http://github.com/ccls/ruby_extension] - modifications, updates and patches for ruby.
+* {ccls-simply_helpful}[http://github.com/ccls/simply_helpful]
+* {ccls-simply_authorized}[http://github.com/ccls/simply_authorized]
+* {ccls-rails_extension}[http://github.com/ccls/rails_extension]
+
+This gem would then be used by ALL of the ccls apps and the engine and the aforementioned gems can and should be removed from the machines to avoid accidental usage.  The following would be kept separate and used only for testing only by this gem.  SimplySessions might actually be includable within just the test environment of CommonLib.
+
+* {ccls-simply_sessions}[http://github.com/ccls/simply_sessions]
+
+
+And the following would be used by ALL ccls apps and gems and probably included in the config/environments/test.rb as "config.gem 'ccls-html_test'"
+
+* {ccls-html_test}[http://github.com/ccls/html_test]
+
+
+Unfortunately, this has all gotten kinda muddled, making it a bit confusing.  This would take at least a day of importing and merging and testing and installing and testing and ...
+
+
+
+---
+== Date.today
+
+DO NOT USE Date.today, unless the following is what you want.
+
+It will compute a Date and disregard the time zone.
+
+In rails, this means that occassionally Date.today == Date.tomorrow
+or Date.today == Date.yesterday, depending on what time it is.
+
+The Rails methods of Date.tomorrow and Date.yesterday reference
+Date.current, which uses the Time.zone,  making them more accurate.
+
+
+I think that DateTime.now and Time.now also ignore the timezone.
+
+Use DateTime.current or Time.zone.now
+
+
+
+
+---
+== validations_from_yaml_file
+
+This ActiveRecord::Base method takes no arguments and is straight forward but deserves a few notes.
+
+Firstly, it will look for a '.yml' file in config/validations/ with the class name underscored.
+
+Each entry is read in as a hash and passed to 'validates'.
+
+Most validations are straight forward, with 2 current exceptions.  I tried many ways.  Searched online
+for some time.  Got a lot of negative feedback.  Mostly "why do it", "don't do it", "not standard", blah, blah.
+So.  Of course I did it anyway.  The 2 objects that cause the most confusion are ranges, useful in length limitations,
+and regexps, useful in formatting emails, ssns, zip codes, phone numbers, ...  The solution is rather simple
+and built in to ruby.  These things simply need a bit to declare what object they are.
+
+* Ranges
+  * :in: !ruby/range 4..250
+
+* Regular Expressions
+  * :with: !ruby/regexp '/^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i'
+  * note that the single quotes around the regexp are unneccessary and problematic if the regex contains one.
+
+For other references, see ...
+
+http://codereview.stackexchange.com/questions/159/use-of-a-regex-stored-inside-yaml-file
+
+http://stackoverflow.com/questions/3337020/how-to-specify-ranges-in-yaml
+
+http://www.opensource.apple.com/source/ruby/ruby-14/ruby/lib/yaml/rubytypes.rb
+
+http://yaml4r.sourceforge.net/doc/page/objects_in_yaml.htm
+
+Or ...
+
+ /opt/local/lib/ruby1.9/1.9.1/syck/rubytypes.rb
+ /opt/local/lib/ruby1.9/1.9.1/psych/visitors/to_ruby.rb
+
+
+
+== Testing
+---
+
+ sudo /opt/local/share/mariadb/support-files/mysql.server start &
+
+ c ; /bin/rm -rf coverage* ; bundle exec rake ; mv coverage coverage-one-run ; open coverage-one-run/index.html ; nice +20 bundle exec autotest
+
+
+---
+== Gemified with Jeweler
+
+ vi Rakefile
+ rake version:write
+
+ rake version:bump:patch
+ rake version:bump:minor
+ rake version:bump:major
+
+ rake gemspec
+
+ rake install
+ rake release
+
+Copyright (c) 2010 [Jake Wendt], released under the MIT license

data/lib/ccls-common_lib.rb

@@ -0,0 +1 @@
+require 'common_lib'

data/lib/common_lib.rb

@@ -0,0 +1,37 @@
+#	because HashWithIndifferentAccess is just too long a name
+HWIA = HashWithIndifferentAccess
+
+module CommonLib; end
+
+require "common_lib/ruby"
+require "common_lib/translation_table"
+
+def brand	#	for auto-generated tests
+	"@@ "
+end
+require 'common_lib/active_support_extension'
+#require 'common_lib/active_record_extension'
+require 'common_lib/active_model'
+require 'common_lib/active_record'
+require 'common_lib/action_controller_extension'
+require 'common_lib/action_view_extension'
+
+
+#	pretty much always as don't expect this to be used outside of a rails app
+require 'common_lib/railtie' if defined?(Rails)
+
+
+
+
+
+
+require 'hpricot'
+ActionView::Base.field_error_proc = Proc.new { |html_tag, instance| 
+	error_class = 'field_error'
+	nodes = Hpricot(html_tag)
+	nodes.each_child { |node| 
+		node[:class] = node.classes.push(error_class).join(' ') unless !node.elem? || node[:type] == 'hidden' || node.classes.include?(error_class) 
+	}
+	nodes.to_html.html_safe
+}
+

data/lib/common_lib/action_controller_extension.rb

@@ -0,0 +1,8 @@
+module CommonLib::ActionControllerExtension; end
+if defined?(Rails) and Rails.env == 'test'
+require 'common_lib/action_controller_extension/test_case'
+#	I don't bother testing http versus https in rails 3
+#require 'common_lib/action_controller_extension/accessible_via_protocol'
+require 'common_lib/action_controller_extension/accessible_via_user'
+require 'common_lib/action_controller_extension/routing'
+end

data/lib/common_lib/action_controller_extension/accessible_via_protocol.rb

@@ -0,0 +1,405 @@
+module CommonLib::ActionControllerExtension::AccessibleViaProtocol
+
+	def self.included(base)
+		base.extend ClassMethods
+	end
+
+	module ClassMethods
+
+		def awihttp_title(options={})
+			"with #{options[:login]} login#{options[:suffix]}"
+		end
+
+		def assert_access_with_http(*actions)
+			user_options = actions.extract_options!
+
+			options = {
+				:login => :admin 
+			}
+			if ( self.constants.include?('ASSERT_ACCESS_OPTIONS') )
+				options.merge!(self::ASSERT_ACCESS_OPTIONS)
+			end
+			options.merge!(user_options)
+			actions += options[:actions]||[]
+
+			m_key = options[:model].try(:underscore).try(:to_sym)
+
+			test "#{brand}AWiHTTP should get new #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args = options[:new] || {}
+				send(:get,:new,args)
+				assert_response :success
+				assert_template 'new'
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:new) || options.keys.include?(:new)
+
+			test "#{brand}AWiHTTP should post create #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args = if options[:create]
+					options[:create]
+				elsif options[:attributes_for_create]
+					{m_key => send(options[:attributes_for_create])}
+				else
+					{}
+				end
+				assert_difference("#{options[:model]}.count",1) do
+					send(:post,:create,args)
+				end
+				assert_response :redirect
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:create) || options.keys.include?(:create)
+
+			test "#{brand}AWiHTTP should get edit #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				send(:get,:edit, args)
+				assert_response :success
+				assert_template 'edit'
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:edit) || options.keys.include?(:edit)
+
+			test "#{brand}AWiHTTP should put update #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create] && options[:attributes_for_create]
+					obj = send(options[:method_for_create],
+						:updated_at => ( Time.now - 2.days ) )
+					args[:id] = obj.id
+					args[m_key] = send(options[:attributes_for_create])
+				end
+				before = obj.updated_at if obj
+#				sleep 1 if obj  # if updated too quickly, updated_at won't change
+				send(:put,:update, args)
+				after = obj.reload.updated_at if obj
+				assert_not_equal( before.to_i,after.to_i, "updated_at did not change" ) if obj
+				assert_response :redirect
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:update) || options.keys.include?(:update)
+
+			test "#{brand}AWiHTTP should get show #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				send(:get,:show, args)
+				assert_response :success
+				assert_template 'show'
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:show) || options.keys.include?(:show)
+
+			test "#{brand}AWiHTTP should delete destroy #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				assert_difference("#{options[:model]}.count",-1) do
+					send(:delete,:destroy,args)
+				end
+				assert_response :redirect
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:destroy) || options.keys.include?(:destroy)
+
+			test "#{brand}AWiHTTP should get index #{awihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				get :index
+				assert_response :success
+				assert_template 'index'
+				assert assigns(m_key.try(:to_s).try(:pluralize).try(:to_sym)), 
+					"#{m_key.try(:to_s).try(:pluralize).try(:to_sym)} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:index) || options.keys.include?(:index)
+
+			test "#{brand}AWiHTTP should get index #{awihttp_title(options)} and items" do
+				turn_https_off
+				send(options[:before]) if !options[:before].blank?
+				login_as send(options[:login])
+				3.times{ send(options[:method_for_create]) } if !options[:method_for_create].blank?
+				get :index
+				assert_response :success
+				assert_template 'index'
+				assert assigns(m_key.try(:to_s).try(:pluralize).try(:to_sym)),
+					"#{m_key.try(:to_s).try(:pluralize).try(:to_sym)} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:index) || options.keys.include?(:index)
+
+		end
+
+		def awihttps_title(options={})
+			"with #{options[:login]} login#{options[:suffix]}"
+		end
+
+		def assert_access_with_https(*actions)
+			user_options = actions.extract_options!
+
+			options = {
+				:login => :admin
+			}
+			if ( self.constants.include?('ASSERT_ACCESS_OPTIONS') )
+				options.merge!(self::ASSERT_ACCESS_OPTIONS)
+			end
+			options.merge!(user_options)
+			actions += options[:actions]||[]
+
+			m_key = options[:model].try(:underscore).try(:to_sym)
+
+			test "#{brand}AWiHTTPS should get new #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				args = options[:new] || {}
+				turn_https_on
+				send(:get,:new,args)
+				assert_response :success
+				assert_template 'new'
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:new) || options.keys.include?(:new)
+
+			test "#{brand}AWiHTTPS should post create #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				args = if options[:create]
+					options[:create]
+				elsif options[:attributes_for_create]
+					{m_key => send(options[:attributes_for_create])}
+				else
+					{}
+				end
+				turn_https_on
+				assert_difference("#{options[:model]}.count",1) do
+					send(:post,:create,args)
+				end
+				assert_response :redirect
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:create) || options.keys.include?(:create)
+
+			test "#{brand}AWiHTTPS should get edit #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				turn_https_on
+				send(:get,:edit, args)
+				assert_response :success
+				assert_template 'edit'
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:edit) || options.keys.include?(:edit)
+
+			test "#{brand}AWiHTTPS should put update #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create] && options[:attributes_for_create]
+					obj = send(options[:method_for_create],
+						:updated_at => ( Time.now - 2.days ) )
+					args[:id] = obj.id
+					args[m_key] = send(options[:attributes_for_create])
+				end
+				before = obj.updated_at if obj
+#				sleep 1 if obj  # if updated too quickly, updated_at won't change
+				turn_https_on
+				send(:put,:update, args)
+				after = obj.reload.updated_at if obj
+				assert_not_equal( before.to_i,after.to_i, "updated_at did not change" ) if obj
+				assert_response :redirect
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:update) || options.keys.include?(:update)
+
+			test "#{brand}AWiHTTPS should get show #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				turn_https_on
+				send(:get,:show, args)
+				assert_response :success
+				assert_template 'show'
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:show) || options.keys.include?(:show)
+
+			test "#{brand}AWiHTTPS should delete destroy #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				turn_https_on
+				assert_difference("#{options[:model]}.count",-1) do
+					send(:delete,:destroy,args)
+				end
+				assert_response :redirect
+				assert assigns(m_key), "#{m_key} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:destroy) || options.keys.include?(:destroy)
+
+			test "#{brand}AWiHTTPS should get index #{awihttps_title(options)}" do
+				login_as send(options[:login])
+				turn_https_on
+				get :index
+				assert_response :success
+				assert_template 'index'
+				assert assigns(m_key.try(:to_s).try(:pluralize).try(:to_sym)),
+					"#{m_key.try(:to_s).try(:pluralize).try(:to_sym)} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:index) || options.keys.include?(:index)
+
+			test "#{brand}AWiHTTPS should get index #{awihttps_title(options)} and items" do
+				send(options[:before]) if !options[:before].blank?
+				login_as send(options[:login])
+				3.times{ send(options[:method_for_create]) } if !options[:method_for_create].blank?
+				turn_https_on
+				get :index
+				assert_response :success
+				assert_template 'index'
+				assert assigns(m_key.try(:to_s).try(:pluralize).try(:to_sym)),
+					"#{m_key.try(:to_s).try(:pluralize).try(:to_sym)} was not assigned"
+				assert_nil flash[:error], "flash[:error] was not nil"
+			end if actions.include?(:index) || options.keys.include?(:index)
+
+		end
+
+		def nawihttp_title(options={})
+			"with #{options[:login]} login#{options[:suffix]}"
+		end
+
+		def assert_no_access_with_http(*actions)
+			user_options = actions.extract_options!
+
+			options = {
+				:login => :admin
+			}
+			if ( self.constants.include?('ASSERT_ACCESS_OPTIONS') )
+				options.merge!(self::ASSERT_ACCESS_OPTIONS)
+			end
+			options.merge!(user_options)
+			actions += options[:actions]||[]
+
+			m_key = options[:model].try(:underscore).try(:to_sym)
+
+			test "#{brand}NAWiHTTP should NOT get new #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args = options[:new]||{}
+				send(:get,:new,args)
+				assert_redirected_to @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'new', :protocol => "https://")
+			end if actions.include?(:new) || options.keys.include?(:new)
+
+			test "#{brand}NAWiHTTP should NOT post create #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args = if options[:create]
+					options[:create]
+				elsif options[:attributes_for_create]
+					{m_key => send(options[:attributes_for_create])}
+				else
+					{}
+				end
+				assert_no_difference("#{options[:model]}.count") do
+					send(:post,:create,args)
+				end
+				assert_match @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'create', :protocol => "https://"),@response.redirected_to
+			end if actions.include?(:create) || options.keys.include?(:create)
+
+			test "#{brand}NAWiHTTP should NOT get edit #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args=options[:edit]||{}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				send(:get,:edit, args)
+				assert_redirected_to @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'edit', :id => args[:id], :protocol => "https://")
+			end if actions.include?(:edit) || options.keys.include?(:edit)
+
+			test "#{brand}NAWiHTTP should NOT put update #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args={}
+				if options[:method_for_create] && options[:attributes_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+					args[m_key] = send(options[:attributes_for_create])
+				end
+				before = obj.updated_at if obj
+				send(:put,:update, args)
+				after = obj.reload.updated_at if obj
+				assert_equal( before.to_s(:db), after.to_s(:db), "updated_at changed" ) if obj
+				assert_match @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'update', :id => args[:id], :protocol => "https://"), @response.redirected_to
+			end if actions.include?(:update) || options.keys.include?(:update)
+
+			test "#{brand}NAWiHTTP should NOT get show #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args=options[:show]||{}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				send(:get,:show, args)
+				assert_redirected_to @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'show', :id => args[:id], :protocol => "https://")
+			end if actions.include?(:show) || options.keys.include?(:show)
+
+			test "#{brand}NAWiHTTP should NOT delete destroy #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				args=options[:destroy]||{}
+				if options[:method_for_create]
+					obj = send(options[:method_for_create])
+					args[:id] = obj.id
+				end
+				assert_no_difference("#{options[:model]}.count") do
+					send(:delete,:destroy,args)
+				end
+				assert_redirected_to @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'destroy', :id => args[:id], :protocol => "https://")
+			end if actions.include?(:destroy) || options.keys.include?(:destroy)
+
+			test "#{brand}NAWiHTTP should NOT get index #{nawihttp_title(options)}" do
+				turn_https_off
+				login_as send(options[:login])
+				get :index
+				assert_redirected_to @controller.url_for(
+					:controller => @controller.controller_name,
+					:action => 'index', :protocol => "https://")
+			end if actions.include?(:index) || options.keys.include?(:index)
+
+		end
+
+	end	# module ClassMethods
+end	#	module CommonLib::ActionControllerExtension::AccessibleViaProtocol
+ActionController::TestCase.send(:include, 
+	CommonLib::ActionControllerExtension::AccessibleViaProtocol)