Merge pull request #28 from dschweisguth/code-cleanup-this-time-for-sure

Code cleanup

Author: januszm

Gemfile

@@ -1,8 +1,6 @@
-# -----------------------------------------------------------------------------
 #
 # Gemfile used for CI testing.
 #
-# -----------------------------------------------------------------------------
 # Copyright 2012 Daniel Azuma
 #
 # All rights reserved.
@@ -30,8 +28,7 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-# -----------------------------------------------------------------------------
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

History.rdoc

@@ -1,3 +1,8 @@
+=== 0.5.2
+
+* Code cleanup, whitespace, comments
+* Use Ruby 1.9+ syntax for hashes
+
 === 0.5.1 / 2017-07-04
 
 * Move dependency on rgeo-activerecord from unreleased 1.0 branch to 1.3.0 release.

README.rdoc

@@ -21,13 +21,13 @@ column may need to be NOT NULL.
 
 Examples (require update):
 
-  create_table :my_spatial_table, :options => 'ENGINE=MyISAM' do |t|
-    t.column :latlon, :point, :null => false
+  create_table :my_spatial_table, options: 'ENGINE=MyISAM' do |t|
+    t.column :latlon, :point, null: false
     t.line_string :path
     t.geometry :shape
   end
   change_table :my_spatial_table do |t|
-    t.index :latlon, :spatial => true
+    t.index :latlon, spatial: true
   end
 
 === Spatial Attributes
@@ -80,11 +80,11 @@ Now you can interact with the data using the RGeo types:
 You can create simple queries based on objective equality in the same way
 you would on a scalar column:
 
-  rec = MySpatialTable.where(:latlon => RGeo::Geos.factory.point(-122, 47)).first
+  rec = MySpatialTable.where(latlon: RGeo::Geos.factory.point(-122, 47)).first
 
 You can also use WKT:
 
-  rec = MySpatialTable.where(:latlon => 'POINT(-122 47)').first
+  rec = MySpatialTable.where(latlon: 'POINT(-122 47)').first
 
 The adapter also provides experimental support for more complex queries
 such as radius searches. However, these extensions require Arel 2.1

Rakefile

@@ -1,8 +1,6 @@
-# -----------------------------------------------------------------------------
 #
 # Generic Gem Rakefile
 #
-# -----------------------------------------------------------------------------
 # Copyright 2010-2012 Daniel Azuma
 #
 # All rights reserved.
@@ -30,8 +28,6 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-# -----------------------------------------------------------------------------
-;
 
 
 # Load config if present
@@ -44,7 +40,6 @@ RAKEFILE_CONFIG = {} unless defined?(::RAKEFILE_CONFIG)
 # Gemspec
 
 require 'rubygems'
-require 'pry'
 gemspec_ = eval(::File.read(::Dir.glob('*.gemspec').first))
 release_gemspec_ = eval(::File.read(::Dir.glob('*.gemspec').first))
 release_gemspec_.version = gemspec_.version.to_s.sub(/\.nonrelease$/, '')
@@ -93,14 +88,14 @@ internal_ext_info_ = gemspec_.extensions.map do |extconf_path_|
   source_dir_ = ::File.dirname(extconf_path_)
   name_ = ::File.basename(source_dir_)
   {
-    :name => name_,
-    :source_dir => source_dir_,
-    :extconf_path => extconf_path_,
-    :source_glob => "#{source_dir_}/*.{c,h}",
-    :obj_glob => "#{source_dir_}/*.{o,dSYM}",
-    :suffix_makefile_path => "#{source_dir_}/Makefile_#{platform_suffix_}",
-    :built_lib_path => "#{source_dir_}/#{name_}.#{dlext_}",
-    :staged_lib_path => "#{source_dir_}/#{name_}_#{platform_suffix_}.#{dlext_}",
+    name: name_,
+    source_dir: source_dir_,
+    extconf_path: extconf_path_,
+    source_glob: "#{source_dir_}/*.{c,h}",
+    obj_glob: "#{source_dir_}/*.{o,dSYM}",
+    suffix_makefile_path: "#{source_dir_}/Makefile_#{platform_suffix_}",
+    built_lib_path: "#{source_dir_}/#{name_}.#{dlext_}",
+    staged_lib_path: "#{source_dir_}/#{name_}_#{platform_suffix_}.#{dlext_}",
   }
 end
 internal_ext_info_ = [] if platform_ == :jruby
@@ -123,7 +118,7 @@ internal_ext_info_.each do |info_|
   end
 end
 
-task :build_ext => internal_ext_info_.map{ |info_| info_[:staged_lib_path] } do
+task build_ext: internal_ext_info_.map{ |info_| info_[:staged_lib_path] } do
   internal_ext_info_.each do |info_|
     target_prefix_ = target_name_ = nil
     ::Dir.chdir(info_[:source_dir]) do
@@ -161,7 +156,7 @@ end
 
 # RDoc tasks
 
-task :build_rdoc => "#{doc_directory_}/index.html"
+task build_rdoc: "#{doc_directory_}/index.html"
 all_rdoc_files_ = ::Dir.glob("lib/**/*.rb") + gemspec_.extra_rdoc_files
 main_rdoc_file_ = ::RAKEFILE_CONFIG[:main_rdoc_file]
 main_rdoc_file_ = 'README.rdoc' if !main_rdoc_file_ && ::File.readable?('README.rdoc')
@@ -184,19 +179,19 @@ end
 
 task :build_other
 
-task :build_gem => :build_other do
+task build_gem: :build_other do
   ::Gem::Builder.new(gemspec_).build
   mkdir_p(pkg_directory_)
   mv "#{gemspec_.name}-#{gemspec_.version}.gem", "#{pkg_directory_}/"
 end
 
-task :build_release => :build_other do
+task build_release: :build_other do
   ::Gem::Builder.new(release_gemspec_).build
   mkdir_p(pkg_directory_)
   mv "#{release_gemspec_.name}-#{release_gemspec_.version}.gem", "#{pkg_directory_}/"
 end
 
-task :release_gem => :build_release do
+task release_gem: :build_release do
   ::Dir.chdir(pkg_directory_) do
     sh "#{::RbConfig::TOPDIR}/bin/gem push #{release_gemspec_.name}-#{release_gemspec_.version}.gem"
   end
@@ -205,7 +200,7 @@ end
 
 # Unit test task
 
-task :test => [:build_ext, :build_other] do
+task test: [:build_ext, :build_other] do
   $:.unshift(::File.expand_path('lib', ::File.dirname(__FILE__)))
   if ::ENV['TESTCASE']
     test_files_ = ::Dir.glob("test/#{::ENV['TESTCASE']}.rb")
@@ -221,4 +216,4 @@ end
 
 # Default task
 
-task :default => [:clean, :test]
+task default: [:clean, :test]

activerecord-mysql2spatial-adapter.gemspec

@@ -1,8 +1,6 @@
-# -----------------------------------------------------------------------------
 #
 # MySQL2 Spatial ActiveRecord Adapter Gemspec
 #
-# -----------------------------------------------------------------------------
 # Copyright 2011-2012 Daniel Azuma
 #
 # All rights reserved.
@@ -30,7 +28,6 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-# -----------------------------------------------------------------------------
 
 ::Gem::Specification.new do |s_|
   s_.name = 'activerecord-mysql2spatial-adapter'
@@ -50,7 +47,6 @@
   s_.add_dependency('activerecord', '>= 4.0', '< 4.2')
   s_.add_dependency('rgeo-activerecord', '~> 1.3')
   s_.add_dependency('mysql2', '>= 0.2.13', '< 0.4.0')
-  s_.add_development_dependency('pry')
   s_.add_development_dependency('rake', '>= 0.9.2')
   s_.add_development_dependency('rdoc', '>= 3.12')
 end

lib/active_record/connection_adapters/mysql2spatial_adapter.rb

@@ -1,8 +1,6 @@
-# -----------------------------------------------------------------------------
 #
 # Mysql2Spatial adapter for ActiveRecord
 #
-# -----------------------------------------------------------------------------
 # Copyright 2010 Daniel Azuma
 #
 # All rights reserved.
@@ -30,26 +28,21 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-# -----------------------------------------------------------------------------
-;
 
 
 require 'rgeo/active_record'
 require 'active_record/connection_adapters/mysql2_adapter'
 
-
 # The activerecord-mysql2spatial-adapter gem installs the *mysql2spatial*
 # connection adapter into ActiveRecord.
 
 module ActiveRecord
 
-
   # ActiveRecord looks for the mysql2spatial_connection factory method in
   # this class.
 
   class Base
 
-
     # Create a mysql2spatial connection adapter.
 
     def self.mysql2spatial_connection(config_)
@@ -62,10 +55,8 @@ def self.mysql2spatial_connection(config_)
       ::ActiveRecord::ConnectionAdapters::Mysql2SpatialAdapter::MainAdapter.new(client_, logger, options_, config_)
     end
 
-
   end
 
-
   # All ActiveRecord adapters go in this namespace.
   module ConnectionAdapters
 
@@ -76,13 +67,9 @@ module Mysql2SpatialAdapter
       ADAPTER_NAME = 'Mysql2Spatial'.freeze
 
     end
-
   end
-
-
 end
 
-
 require 'active_record/connection_adapters/mysql2spatial_adapter/version.rb'
 require 'active_record/connection_adapters/mysql2spatial_adapter/column_methods.rb' # check if this works with Rails < 4.x
 require 'active_record/connection_adapters/mysql2spatial_adapter/main_adapter.rb'

lib/active_record/connection_adapters/mysql2spatial_adapter/arel_tosql.rb

@@ -1,8 +1,6 @@
-# -----------------------------------------------------------------------------
 #
 # Mysql2Spatial adapter for ActiveRecord
 #
-# -----------------------------------------------------------------------------
 # Copyright 2010 Daniel Azuma
 #
 # All rights reserved.
@@ -30,15 +28,12 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-# -----------------------------------------------------------------------------
-;
 
 
 # :stopdoc:
 
 module Arel
   module Visitors
-
     class MySQL2Spatial < MySQL
 
       if ::Arel::Visitors.const_defined?(:BindVisitor)

lib/active_record/connection_adapters/mysql2spatial_adapter/main_adapter.rb

@@ -1,8 +1,6 @@
-# -----------------------------------------------------------------------------
 #
 # Mysql2Spatial adapter for ActiveRecord
 #
-# -----------------------------------------------------------------------------
 # Copyright 2010 Daniel Azuma
 #
 # All rights reserved.
@@ -30,25 +28,17 @@
 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
-# -----------------------------------------------------------------------------
-;
 
 
 # :stopdoc:
 
 module ActiveRecord
-
   module ConnectionAdapters
-
     module Mysql2SpatialAdapter
-
-
       class MainAdapter < ConnectionAdapters::Mysql2Adapter
 
-
         NATIVE_DATABASE_TYPES = Mysql2Adapter::NATIVE_DATABASE_TYPES.merge(spatial: { name: 'geometry' })
 
-
         def initialize(*args_)
           super
           # Rails 3.2 way of defining the visitor: do so in the constructor
@@ -57,36 +47,30 @@ def initialize(*args_)
           end
         end
 
-
         def set_rgeo_factory_settings(factory_settings_)
           @rgeo_factory_settings = factory_settings_
         end
 
-
         def adapter_name
           Mysql2SpatialAdapter::ADAPTER_NAME
         end
 
-
         def spatial_column_constructor(name_)
           ::RGeo::ActiveRecord::DEFAULT_SPATIAL_COLUMN_CONSTRUCTORS[name_]
         end
 
-
         def native_database_types
           NATIVE_DATABASE_TYPES
         end
 
-
         def quote(value_, column_=nil)
           if ::RGeo::Feature::Geometry.check_type(value_)
-            "GeomFromWKB(0x#{::RGeo::WKRep::WKBGenerator.new(:hex_format => true).generate(value_)},#{value_.srid})"
+            "GeomFromWKB(0x#{::RGeo::WKRep::WKBGenerator.new(hex_format: true).generate(value_)},#{value_.srid})"
           else
             super
           end
         end
 
-
         def type_to_sql(type_, limit_=nil, precision_=nil, scale_=nil)
           if (info_ = spatial_column_constructor(type_.to_sym))
             type_ = limit_[:type] || type_ if limit_.is_a?(::Hash)
@@ -96,10 +80,9 @@ def type_to_sql(type_, limit_=nil, precision_=nil, scale_=nil)
           super(type_, limit_, precision_, scale_)
         end
 
-
         def add_index(table_name_, column_name_, options_={})
           if options_[:spatial]
-            index_name_ = index_name(table_name_, :column => Array(column_name_))
+            index_name_ = index_name(table_name_, column: Array(column_name_))
             if ::Hash === options_
               index_name_ = options_[:name] || index_name_
             end
@@ -109,11 +92,10 @@ def add_index(table_name_, column_name_, options_={})
           end
         end
 
-
         def columns(table_name_, name_=nil)
           result_ = execute("SHOW FIELDS FROM #{quote_table_name(table_name_)}", :skip_logging)
           columns_ = []
-          result_.each(:symbolize_keys => true, :as => :hash) do |field_|
+          result_.each(symbolize_keys: true, as: :hash) do |field_|
             columns_ << SpatialColumn.new(@rgeo_factory_settings, table_name_.to_s,
               field_[:Field], field_[:Default], field_[:Type], field_[:Null] == "YES")
           end
@@ -125,7 +107,7 @@ def indexes(table_name_, name_=nil)
           indexes_ = []
           current_index_ = nil
           result_ = execute("SHOW KEYS FROM #{quote_table_name(table_name_)}", name_)
-          result_.each(:symbolize_keys => true, :as => :hash) do |row_|
+          result_.each(symbolize_keys: true, as: :hash) do |row_|
             if current_index_ != row_[:Key_name]
               next if row_[:Key_name] == 'PRIMARY' # skip the primary key
               current_index_ = row_[:Key_name]
@@ -146,15 +128,9 @@ def indexes(table_name_, name_=nil)
           end
           indexes_
         end
-
-
       end
-
-
     end
-
   end
-
 end
 
 # :startdoc: