auto_select2 0.4.1 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 409c72f7b130d808dfbb5592ec99d9c5fe754552
+  data.tar.gz: 1296325a730e078b9515d6515a21811a732d10e5
+SHA512:
+  metadata.gz: e998e6f5233e72020ce24d207d804d57d0b7bfb163976897e2a197dab39e3eecd61dd1bacdf67181ef51d8ea0886b51959d71c6993373de1eb9b84c3ffd0429d
+  data.tar.gz: 5d255209a21df33b4bc1760fd90174b1b081e6c29c05ceb1219de41ddceb68ce710b405a29350e6d945e0baa066c1746bfd531fac9ae7019e41dbed523353c4a

data/README.md

@@ -115,12 +115,10 @@ For initialize static select2 you must set `auto-static-select2` css-class for s
 ### Ajax select2 usage
 
 For initialize ajax select 2 you must set `auto-ajax-select2` css-class for hidden-input element.
-Then you have two ways. Easy way for simple selection: specify `default_class_name`, `default_text_column` and
-`default_id_column` as params for `:href` within data-attribute `s2-options` (look at the end of this section).
-Other way for custom selection: create `SearchAdapter`. This adapter has following requirements:
+Then you need to create a `SearchAdapter`. This adapter has following requirements:
 
 * class must be inherited from `AutoSelect2::Select2SearchAdapter::Base`
-* file must be put in folder `app/select2_search_adapter`
+* file must be put in any folder which included into autoload path, preferably in `app/select2_search_adapter`
 * name of a adapter class must end with `SearchAdapter`
 * must has function `search_default(term, page, options)`
   (description of the function and return value goes below)
@@ -140,7 +138,7 @@ Returned value of `search_default` function must be follow:
       total: count
     }
 
-Here in total must be specified amount of all select variants. For example you have select
+Here in "total" must be specified amount of all select variants. For example you have select
 element with 42 variants. Function `search_default` return part of it in `items` and in
 `total` each time you must set 42.
 
@@ -154,16 +152,19 @@ More about this function you can find in [example project](https://github.com/Lo
 in example below and in source code.
 
 Finally hidden-input must has `:href` parameter in data-attribute `s2-options`. This
-parameter specify url for ajax load select options. You can use helper
+parameter specify url for ajax load select options. You can use path-helper `select2_autocompletes_path` for this purpose.
 
-    select2_autocompletes_path(class_name: :my_class_name)
-or
+### Example of minimalistic SearchAdapter
+
+    class SystemRoleSearchAdapter < AutoSelect2::Select2SearchAdapter::Default
+      searchable_class SystemRole
+      id_column :id
+      text_columns: :name
+      hash_method :to_select2 # optional
+    end
 
-    select2_autocompletes_path(default_class_name: my_class,
-                               default_text_column: :name,
-                               default_id_column: :id)
+More complex example:
 
-### Example of minimalistic SearchAdapter
     class SystemRoleSearchAdapter < AutoSelect2::Select2SearchAdapter::Base
       class << self
         def search_default(term, page, options)
@@ -183,6 +184,18 @@ or
       end
     end
 
+### Generator
+
+Gem provide a rails generator for creating a simple SearchAdapter like a first one from previous section. Run follows command:
+
+    rails generate auto_select2:search_adapter TargetModelName --id-column=name_of_id_column  --text-columns=name_of_columns_for_searching_by
+
+Available options for generator:
+* id-column - name of model column with identifier;
+* text-columns - column for searching by (available multiple values, for example "--text-columns=name description" without coma);
+* hash-method - instance method of model for converting into Hash for transporting into select2 (optional);
+* destination-path - path for storing SearchAdapter classes (optional, default: 'app/select2_search_adapters').
+
 ### More about SearchAdapter
 
 `SearchAdapter` has some additional functions. First, you can define multiple search

data/app/controllers/select2_autocompletes_controller.rb

@@ -3,8 +3,6 @@ class Select2AutocompletesController < ApplicationController
     begin
       if params[:class_name].present?
         adapter = "::#{params[:class_name].camelize}SearchAdapter".constantize
-      elsif params[:default_class_name].present?
-        adapter = ::AutoSelect2::Select2SearchAdapter::Default
       else
         render json: {error: "not enough search parameters'"}.to_json,
                status: 500

data/lib/auto_select2/select2_search_adapter/base.rb

@@ -93,7 +93,7 @@ module AutoSelect2
             if item.respond_to?(:to_select2)
               item.to_select2
             else
-              label_method = text_columns.to_s.split(/[\s,]+/).first || :name
+              label_method = text_columns.first || :name
               if item.respond_to?(label_method)
                 { text: item.public_send(label_method), id: item.public_send(id_column) }
               else

data/lib/auto_select2/select2_search_adapter/default.rb

@@ -3,35 +3,54 @@ module AutoSelect2
     class Default < Base
       class << self
         def search_default(term, page, options)
-          begin
-            default_arel = options[:default_class_name].camelize.constantize
-          rescue NameError
-            return {error: "not found class '#{options[:default_class_name]}'"}.to_json
+          if @searchable_class.blank? || @id_column.blank? || @text_columns.blank?
+            raise_not_implemented
           end
-
           if options[:init].nil?
-            default_values = default_finder(default_arel, term, page: page,
-                                                                column: options[:default_text_column])
-            default_count = default_count(default_arel, term, column: options[:default_text_column])
+            default_values = default_finder(@searchable_class, term, page: page, column: @text_columns)
+            default_count = default_count(@searchable_class, term, column: @text_columns)
             {
                 items: default_values.map do |default_value|
                   get_select2_hash(
                       default_value,
-                      options[:hash_method],
-                      options[:default_id_column],
-                      options[:default_text_column]
+                      @select2_hash_method,
+                      @id_column,
+                      @text_columns
                   )
                 end,
                 total: default_count
             }
           else
             get_init_values(
-                default_arel,
+                @searchable_class,
                 options[:item_ids],
                 options
             )
           end
         end
+
+        private
+
+        def searchable_class(klass)
+          @searchable_class = klass
+        end
+
+        def id_column(id_column)
+          @id_column = id_column
+        end
+
+        def text_columns(*column_names)
+          @text_columns = column_names
+        end
+
+        def hash_method(method_sym)
+          @select2_hash_method = method_sym
+        end
+
+        def raise_not_implemented
+          raise NotImplementedError,
+                'You need to implement your own SearchAdapter. Use: `rails generate auto_select2:search_adapter`'
+        end
       end
     end
   end

data/lib/auto_select2/version.rb

@@ -1,3 +1,3 @@
 module AutoSelect2
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/generators/auto_select2/search_adapter_generator.rb

@@ -0,0 +1,53 @@
+module AutoSelect2
+  module Generators
+    class SearchAdapterGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :destination_path,
+                   type: :string,
+                   default: 'app/select2_search_adapters',
+                   desc: 'Path for storing SearchAdapter classes',
+                   banner: 'lib/search_adapters'
+      class_option :id_column,
+                   type: :string,
+                   desc: 'Name of model column with identifier (i.e. id)',
+                   banner: 'id',
+                   required: true
+      class_option :text_columns,
+                   type: :array,
+                   desc: 'Column for searching by',
+                   banner: 'lastname firstname',
+                   required: true
+      class_option :hash_method,
+                   type: :string,
+                   desc: 'Instance method of model for converting into Hash for transporting into select2',
+                   banner: 'to_select2'
+
+      desc 'Creates SearchAdapter classes for your models'
+      def create_search_adapter
+        template 'search_adapter.rb.erb',
+                 "#{options[:destination_path]}/#{class_path.push(file_name).join('/')}_search_adapter.rb"
+      end
+
+      private
+
+      def id_column
+        options[:id_column]
+      end
+
+      def text_columns
+        options[:text_columns].map do |c|
+          if c.underscore == c
+            ":#{c}"
+          else
+            "\"#{c}\""
+          end
+        end
+      end
+
+      def hash_method
+        options[:hash_method]
+      end
+    end
+  end
+end

data/lib/generators/auto_select2/templates/search_adapter.rb.erb

@@ -0,0 +1,6 @@
+class <%= name.classify %>SearchAdapter < AutoSelect2::Select2SearchAdapter::Default
+  searchable_class <%= name.classify %>
+  id_column :<%= id_column %>
+  text_columns <%= text_columns.join(', ') %>
+  <% if hash_method.present? %>hash_method :<%= hash_method %><% end %>
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auto_select2
 version: !ruby/object:Gem::Version
-  version: 0.4.1
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Dmitriy Lisichkin
@@ -10,107 +9,96 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: select2-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.12
-description: ! "    Gem provide scripts and helpers for initialize different select2
-  elements:\n    static, ajax and multi-ajax. Moreover this gem is foundation for
-  other gems.\n    For example for AutoSelect2Tab.\n"
+description: |2
+      Gem provide scripts and helpers for initialize different select2 elements:
+      static, ajax and multi-ajax. Moreover this gem is foundation for other gems.
+      For example for AutoSelect2Tab.
 email:
 - dima@sb42.ru
 - loriowar@gmail.com
@@ -118,8 +106,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .gitmodules
+- ".gitignore"
+- ".gitmodules"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,6 +123,8 @@ files:
 - lib/auto_select2/select2_search_adapter/base.rb
 - lib/auto_select2/select2_search_adapter/default.rb
 - lib/auto_select2/version.rb
+- lib/generators/auto_select2/search_adapter_generator.rb
+- lib/generators/auto_select2/templates/search_adapter.rb.erb
 - vendor/assets/javascripts/auto_select2/ajax_select2.js.coffee
 - vendor/assets/javascripts/auto_select2/data_select2.js.coffee
 - vendor/assets/javascripts/auto_select2/multi_ajax_select2_value_parser.js.coffee
@@ -142,26 +132,25 @@ files:
 homepage: https://github.com/Loriowar/auto_select2
 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Base methods for wrapping a Select2 and easy initialize it.
 test_files: []