stringex 2.0.11 → 2.8.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDc3OWVmOWMzZGQwOGRlZDI1YjRmYmNiYWJhZTkwOTFmNjAwZDQ1OQ==
-  data.tar.gz: !binary |-
-    ODdiMzBhMDM2ZjYwYjI5ZTI1OGJmYjZlYTlhZDdjMmRhN2FhZDE4YQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YzcxMTU1MjUzMTg4OTVhNmRiMjYyNTAwNTllNTE4ODFlMThhMmYxYzkwZjAz
-    NjEyYzg0ODhkYWUwOGQzYmVlMDBkYmQ3OWU3ZjE2NzQwOWRjYWY2NjZkNTYz
-    NjM0ZDU1M2I0YzljZjQ5NmM2YzA2ZDRjMDYwOGEyYTgzNTQxODY=
-  data.tar.gz: !binary |-
-    ZjcwZTkzODcwNzA5OWJkZmU4ZjEzZDI5MjQ2YjgwYTMxYmM1YWIyOTkwNWEx
-    ODZiOWUxMTQzZTkwMGVjNTlhN2I0Y2FmNTQ0ZWM1MWJhMzhmOWVmNjc3MDI4
-    NTQxNzIzZTdkNjQ1OGFiODUyMTNjODE4MDI5Yjk5MWE1NmFjMTg=
+SHA256:
+  metadata.gz: 1b26eaa16536e306141877a8ee3f50acdd23d8cb3601fe1830ccf798e7a2b433
+  data.tar.gz: 8062ea4ee5667139acb8337fa979d212ab1ef52a69a1303efd302df142c83c8c
+SHA512:
+  metadata.gz: 7179fa45397f05d438470e2ae225e0e4ac03a6f0cf2922af031ca4e7c68bb7be20d8d833bab9f928782687ccc78f5cdac30142a2923941e23441616b948b3041
+  data.tar.gz: b42d191422c1340122677106d7360a05ec6c41f30206f577701a276ac253509a3f4553a5f628b383b3aed4fa293e4c0b7498eb0466cc565eeaefe576e9ebba08

data/Gemfile

@@ -1,20 +1,51 @@
 # A sample Gemfile
-source "https://rubygems.org"
+source 'https://rubygems.org'
+
+def activerecord?
+  adapter.nil? || adapter == 'activerecord'
+end
+
+def datamapper?
+  adapter == 'datamapper'
+end
+
+def mongoid?
+  if RUBY_VERSION > '1.8.x'
+    adapter == 'mongoid'
+  else
+    puts 'Mongoid requires Ruby higher than 1.8.x'
+  end
+end
+
+def adapter
+  ENV['ADAPTER']
+end
 
 group :development do
-  gem "activerecord", "3.2.13"
-  gem "dm-core", "1.2.0"
-  gem "dm-migrations", "1.2.0"
-  gem "dm-sqlite-adapter", "1.2.0"
-  gem "dm-validations", "1.2.0"
-  gem "jeweler", "1.8.4"
-  if RUBY_VERSION > "1.8.x"
-    gem "mongoid", "3.1.4"
+  # Standard gems across gemfiles
+  gem 'jeweler', '2.3.7'
+  gem 'travis-lint', '1.7.0'
+  # Can I state that I really dislike camelcased gem names?
+  gem 'RedCloth', '4.2.9'
+  gem 'sqlite3', '1.3.10'
+  gem 'test-unit', '3.0.9'
+
+  if activerecord?
+    gem 'activerecord', '5.1.4'
+  end
+
+  if datamapper?
+    gem 'dm-core', '1.2.1'
+    gem 'dm-migrations', '1.2.0'
+    gem 'dm-sqlite-adapter', '1.2.0'
+    gem 'dm-validations', '1.2.0'
+  end
+
+  if mongoid?
+    gem 'mongoid', '3.1.6'
+    gem 'i18n', '0.6.1'
   else
-    puts "Mongoid requires Ruby higher than 1.8.x"
+    # Everyone else can get the most up-to-date I18n
+    gem 'i18n', '0.7.0'
   end
-  gem "RedCloth", "4.2.9" # Can I state that I really dislike camelcased gem names?
-  gem "sqlite3", "1.3.7"
-  gem "travis-lint", "1.7.0"
-  gem "i18n", "0.6.1"
 end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2012 Lucky Sneaks
+Copyright (c) 2008-2014 Lucky Sneaks
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,162 @@
+# Stringex [<img src="https://codeclimate.com/github/rsl/stringex.svg" />](https://codeclimate.com/github/rsl/stringex) [<img src="https://travis-ci.org/rsl/stringex.svg?branch=master" alt="Build Status" />](https://travis-ci.org/rsl/stringex) [<img src="https://badge.fury.io/rb/stringex.svg" alt="Gem Version" />](http://badge.fury.io/rb/stringex)
+
+Some [hopefully] useful extensions to Ruby's String class. It is made up of three libraries: ActsAsUrl, Unidecoder, and StringExtensions.
+
+*NOTE: Stringex 2.0 [and beyond] drops support for Rails 2. If you need support for that version, use 1.5.1 instead.*
+
+## ActsAsUrl
+
+*NOTE: You can now require 'stringex_lite' instead of 'stringex' and skip loading ActsAsUrl functionality if you don't need it.*
+
+This library is designed to create URI-friendly representations of an attribute, for use in generating urls from your attributes. Basic usage is just calling the method:
+
+```ruby
+# Inside your model
+acts_as_url :title
+```
+
+which will populate the `url` attribute on the object with the converted contents of the `title` attribute. `acts_as_url` takes the following options:
+
+| | |
+|---|---|
+| `:url_attribute` | The name of the attribute to use for storing the generated url string. Default is `:url` |
+| `:scope` | The name of model attribute to scope unique urls to. There is no default here. |
+| `:only_when_blank` | If set to true, the url generation will only happen when `:url_attribute` is blank. Default is false (meaning url generation will happen always). |
+| `:sync_url` | If set to true, the url field will be updated when changes are made to the attribute it is based on. Default is false. |
+| `:allow_slash` | If set to true, the url field will not convert slashes. Default is false. |
+| `:allow_duplicates` | If set to true, unique urls will not be enforced. Default is false. *NOTE: This is strongly not recommended if you are routing solely on the generated slug as you will no longer be guaranteed to lookup the expected record based on a duplicate slug.* |
+| `:limit` | If set, will limit length of url generated. Default is nil. |
+| `:truncate_words` | Used with :limit. If set to false, the url will be truncated to the last whole word before the limit was reached. Default is true. |
+| `:blacklist` | List of urls that should not be allowed. Default is `%w{new}` [which avoids confusion on urls like `/documents/new`]. |
+| `:blacklist_policy` | Proc or lambda defining new naming behavior when blacklisted urls are encountered. Default converts `/documents/new` to `/documents/new-document`. |
+
+In order to use the generated url attribute, you will probably want to
+override `to_param` like so, in your Model:
+
+```ruby
+# Inside your model
+def to_param
+  url # or whatever you set :url_attribute to
+end
+```
+
+Routing called via named routes like `foo_path(@foo)` will automatically use the url. In your controllers you will need to call
+`Foo.find_by_url(params[:id])` instead of the regular find. Don't look for `params[:url]` unless you set it explicitly in the routing, `to_param` will generate `params[:id]`.
+
+Note that if you add `acts_as_url` to an existing model, the `url` database column will initially be blank. To set this column for your existing instances, you can use the `initialize_urls` method. So if your class is `Post`, just say `Post.initialize_urls`.
+
+Unlike other permalink solutions, ActsAsUrl doesn't rely on Iconv (which is inconsistent across platforms and doesn't provide great transliteration as is) but instead uses a transliteration scheme (see the code for Unidecoder) which produces much better results for Unicode characters. It also mixes in some custom helpers to translate common characters into a more URI-friendly format rather than just dump them completely. Examples:
+
+```ruby
+# A simple prelude
+"simple English".to_url => "simple-english"
+"it's nothing at all".to_url => "its-nothing-at-all"
+"rock & roll".to_url => "rock-and-roll"
+
+# Let's show off
+"$12 worth of Ruby power".to_url => "12-dollars-worth-of-ruby-power"
+"10% off if you act now".to_url => "10-percent-off-if-you-act-now"
+
+# You dont EVEN wanna rely on Iconv for this next part
+"kick it en Français".to_url => "kick-it-en-francais"
+"rock it Español style".to_url => "rock-it-espanol-style"
+"tell your readers 你好".to_url => "tell-your-readers-ni-hao"
+```
+
+Compare those results with the ones produced on my Intel Mac by a leading permalink plugin:
+
+```ruby
+"simple English" # => "simple-english"
+"it's nothing at all" # => "it-s-nothing-at-all"
+"rock & roll" # => "rock-roll"
+
+"$12 worth of Ruby power" # => "12-worth-of-ruby-power"
+"10% off if you act now" # => "10-off-if-you-act-now"
+
+"kick it en Français" # => "kick-it-en-francais"
+"rock it Español style" # => "rock-it-espan-ol-style"
+"tell your readers 你好" # => "tell-your-readers"
+```
+
+Not so great, actually.
+
+Note: No offense is intended to the author(s) of whatever plugins might produce such results. It's not your faults Iconv sucks.
+
+## Unidecoder
+
+This library converts Unicode [and accented ASCII] characters to their plain-text ASCII equivalents. This is a port of Perl's Unidecode and provides eminently superior and more reliable results than Iconv. (Seriously, Iconv... A plague on both your houses! [sic])
+
+You may require only the unidecoder (and its dependent localization) via
+
+```ruby
+require "stringex/unidecoder"
+```
+
+You probably won't ever need to run Unidecoder by itself. Thus, you probably would want to add String#to_ascii which wraps all of Unidecoder's functionality, by requiring:
+
+```ruby
+require "stringex/core_ext"
+```
+
+For anyone interested, details of the implementation can be read about in the original implementation of [Text::Unidecode](http://interglacial.com/~sburke/tpj/as_html/tpj22.html). Extensive examples can be found in the tests.
+
+## StringExtensions
+
+A small collection of extensions on Ruby's String class. Please see the documentation for StringExtensions module for more information. There's not much to explain about them really.
+
+## Localization
+
+With Stringex version 2.0 and higher, you can localize the different conversions in Stringex. Read more [here](https://github.com/rsl/stringex/wiki/Localization-of-Stringex-conversions). If you add a new language, please submit a pull request so we can make it available to other users also.
+
+## Ruby on Rails Usage
+
+When using Stringex with Ruby on Rails, you automatically get built-in translations for miscellaneous characters, HTML entities, and vulgar fractions. You can see Stringex's standard translations [here](https://github.com/rsl/stringex/tree/master/locales).
+
+Currently, built-in translations are available for the following languages:
+
+* English (en)
+* Danish (da)
+* Swedish (sv)
+* Dutch (nl)
+* German (de)
+* Polish (pl)
+* Portuguese Brazilian (pt-BR)
+* Russian (ru)
+
+You can easily add your own or customize the built-in translations - read [here](https://github.com/rsl/stringex/wiki/Localization-of-Stringex-conversions). If you add a new language, please submit a pull request so we can make it available to other users also.
+
+If you don't want to use the Stringex built-in translations, you can force Stringex to use English (or another language), regardless what is in your `I18n.locale`. In an initializer, e.g. `config/initializers/stringex.rb`:
+
+```ruby
+Stringex::Localization.locale = :en
+```
+
+## CanCan Usage Note
+
+You'll need to add a `:find_by => :url` to your `load_and_authorize_resource`. Here's an example:
+
+```ruby
+load_and_authorize_resource :class => "Whatever", :message => "Not authorized", :find_by => :url
+```
+
+## Semantic Versioning
+
+This project conforms to [semver](http://semver.org/). As a result of this policy, you can (and should) specify a dependency on this gem using the [Pessimistic Version Constraint](http://guides.rubygems.org/patterns/) with two digits of precision. For example:
+
+```ruby
+spec.add_dependency 'stringex', '~> 1.0'
+```
+
+This means your project is compatible with licensee 1.0 up until 2.0. You can also set a higher minimum version:
+
+```ruby
+spec.add_dependency 'stringex', '~> 1.1'
+```
+
+## Thanks & Acknowledgements
+
+If it's not obvious, some of the code for ActsAsUrl is based on Rick Olsen's [permalink_fu](http://svn.techno-weenie.net/projects/plugins/permalink_fu/) plugin. Unidecoder is a Ruby port of Sean Burke's [Text::Unidecode](http://interglacial.com/~sburke/tpj/as_html/tpj22.html) module for Perl. And, finally, the bulk of [strip_html_tags](classes/Stringex/StringExtensions.html#M000005) in StringExtensions was stolen from Tobias Lütke's Regex in [Typo](http://typosphere.org/).
+
+GIANT thanks to the many contributors who have helped make Stringex better and better: http://github.com/rsl/stringex/contributors
+
+Copyright (c) 2008-2018 Lucky Sneaks, released under the MIT license

data/Rakefile

@@ -30,46 +30,20 @@ end
 Rake::TestTask.new do |t|
   t.libs << 'lib' << 'test'
   t.pattern   = 'test/unit/**/*_test.rb'
-  t.verbose   = true
+  t.verbose   = false
+  t.warning   = false
 end
 
 namespace :test do
   Rake::TestTask.new(:performance) do |t|
     t.libs << 'lib' << 'test'
     t.pattern   = 'test/performance/**/*_test.rb'
-    t.verbose   = true
+    t.verbose   = false
+    t.warning   = false
   end
 end
 
-desc 'Default: Run Stringex test suite using ActiveRecord as the ORM'
-task :default => [:setup_active_record_suite, :test]
-
-task :setup_active_record_suite do
-  ENV['ADAPTER'] = 'active_record'
-end
-
-desc 'Run Stringex test suite using ActiveRecord as the ORM'
-namespace :test do
-  task :active_record => [:setup_active_record_suite]
-end
-
-task :setup_mongoid_suite do
-  ENV['ADAPTER'] = 'mongoid'
-end
-
-desc 'Run Stringex test suite using Mongoid as the ORM'
-namespace :test do
-  task :mongoid => [:setup_mongoid_suite, :test]
-end
-
-task :setup_data_mapper_suite do
-  ENV['ADAPTER'] = 'data_mapper'
-end
-
-desc 'Run Stringex test suite using DataMapper as the ORM'
-namespace :test do
-  task :data_mapper => [:setup_data_mapper_suite, :test]
-end
+task :default => :test
 
 desc 'Generate RDoc for Stringex'
 Rake::RDocTask.new(:rdoc) do |rdoc|

data/VERSION

@@ -1 +1 @@
-2.0.11
+2.8.6

data/lib/stringex/acts_as_url/adapter/active_record.rb

@@ -11,7 +11,7 @@ module Stringex
       private
 
         def klass_previous_instances(&block)
-          klass.find_each(:conditions => {settings.url_attribute => [nil, '']}, &block)
+          klass.where(settings.url_attribute => [nil, '']).find_each(&block)
         end
 
         def self.orm_class

data/lib/stringex/acts_as_url/adapter/base.rb

@@ -22,6 +22,7 @@ module Stringex
           self.instance = instance
 
           handle_url!
+          handle_blacklisted_url!
           handle_duplicate_url! unless settings.allow_duplicates
         end
 
@@ -69,7 +70,11 @@ module Stringex
         end
 
         def create_callback
-          klass.send klass_callback_method, :ensure_unique_url, callback_options
+          klass.send(
+            klass_callback_method,
+            :ensure_unique_url,
+            **callback_options
+          )
         end
 
         def klass_callback_method
@@ -118,20 +123,47 @@ module Stringex
         end
 
         def handle_duplicate_url!
-          return if url_owners.none?{|owner| url_attribute_for(owner) == base_url}
-          n = 1
-          while url_owners.any?{|owner| url_attribute_for(owner) == duplicate_for_base_url(n)}
-            n = n.succ
+          return if !url_taken?(base_url)
+          n = nil
+          sequence = duplicate_url_sequence.tap(&:rewind)
+          loop do
+            n = sequence.next
+            break unless url_taken?(duplicate_for_base_url(n))
           end
           write_url_attribute duplicate_for_base_url(n)
         end
 
+        def duplicate_url_sequence
+          settings.duplicate_sequence ||
+            Enumerator.new do |enum|
+              n = 1
+              loop do
+                enum.yield n
+                n += 1
+              end
+            end
+        end
+
+        def url_taken?(url)
+          if settings.url_taken_method
+            instance.send(settings.url_taken_method, url)
+          else
+            url_owners.any?{|owner| url_attribute_for(owner) == url}
+          end
+        end
+
         def handle_url!
           self.base_url = instance.send(settings.url_attribute)
           modify_base_url if is_blank?(base_url) || !settings.only_when_blank
           write_url_attribute base_url
         end
 
+        def handle_blacklisted_url!
+          return unless settings.blacklist.to_set.include?(base_url)
+          self.base_url = settings.blacklist_policy.call(instance, base_url)
+          write_url_attribute base_url
+        end
+
         def instance_from_db
           instance.class.find(instance.id)
         end

data/lib/stringex/acts_as_url/adapter/data_mapper.rb

@@ -33,19 +33,15 @@ module Stringex
         end
 
         def klass_previous_instances(&block)
-          klass.all(:conditions => {settings.url_attribute => [nil]}).each(&block)
+          klass.all(conditions: {settings.url_attribute => [nil]}).each(&block)
         end
 
         def primary_key
           instance.class.key.first.instance_variable_get '@name'
         end
 
-        def read_attribute(instance, attribute)
-          instance.attributes[attribute]
-        end
-
         def url_owners
-          @url_owners ||= url_owners_class.all(:conditions => url_owner_conditions)
+          @url_owners ||= url_owners_class.all(conditions: url_owner_conditions)
         end
 
         def read_attribute(instance, name)
@@ -62,4 +58,4 @@ module Stringex
       end
     end
   end
-end
+end

data/lib/stringex/acts_as_url/adapter/mongoid.rb

@@ -11,7 +11,7 @@ module Stringex
 
         def add_new_record_url_owner_conditions
           return if instance.new_record?
-          @url_owner_conditions.merge! :id => {'$ne' => instance.id}
+          @url_owner_conditions.merge! id: {'$ne' => instance.id}
         end
 
         def add_scoped_url_owner_conditions
@@ -34,4 +34,4 @@ module Stringex
       end
     end
   end
-end
+end

data/lib/stringex/acts_as_url.rb

@@ -4,7 +4,7 @@ require "stringex/acts_as_url/adapter"
 module Stringex
   module ActsAsUrl # :nodoc:
     def self.configure(&block)
-      Stringex::Configuration::ActsAsUrl.configure &block
+      Stringex::Configuration::ActsAsUrl.configure(&block)
     end
 
     def self.unconfigure!
@@ -33,6 +33,11 @@ module Stringex
       #                              differentiate between urls. Default is false[y]. See note on <tt>:scope</tt>.
       # <tt>:duplicate_count_separator</tt>:: String to use when forcing unique urls from non-unique strings.
       #                                       Default is "-".
+      # <tt>:duplicate_sequence</tt>:: Supply an enumerator to generate the values used to generate
+      #                                unique urls (when <tt>:allow_duplicates</tt> is false).
+      #                                By default, generates positive integers in sequence from 1.
+      #                                <strong>Note:</strong> The sequence is restarted for each record
+      #                                (by calling <tt>#rewind</tt>).
       # <tt>:force_downcase</tt>:: If false, allows generated url to contain uppercased letters. Default is false.
       # <tt>:exclude_list</tt>:: List of complete strings that should not be transformed by <tt>acts_as_url</tt>.
       #                          Default is empty.
@@ -72,11 +77,13 @@ module Stringex
 
       # Some ORMs function as mixins not base classes and need to have a hook to reinclude
       # and re-extend ActsAsUrl methods
-      def included(base)
+      def included(base = nil, &block)
         super
 
-        base.send :include, Stringex::ActsAsUrl::ActsAsUrlInstanceMethods
-        base.send :extend, Stringex::ActsAsUrl::ActsAsUrlClassMethods
+        if base
+          base.send :include, Stringex::ActsAsUrl::ActsAsUrlInstanceMethods
+          base.send :extend, Stringex::ActsAsUrl::ActsAsUrlClassMethods
+        end
       end
 
       # Initialize the url fields for the records that need it. Designed for people who add

data/lib/stringex/configuration/acts_as_url.rb

@@ -14,7 +14,8 @@ module Stringex
           :exclude,
           :force_downcase,
           :limit,
-          :replace_whitespace_with
+          :replace_whitespace_with,
+          :truncate_words
         ].inject(Hash.new){|m, x| m[x] = settings.send(x); m}
       end
 
@@ -30,16 +31,20 @@ module Stringex
 
       def self.default_settings
         @default_settings ||= {
-          :allow_duplicates => false,
-          :callback_method => :before_validation,
-          :duplicate_count_separator => "-",
-          :enforce_uniqueness_on_sti_class => false,
-          :only_when_blank => false,
-          :scope_for_url => nil,
-          :sync_url => false,
-          :url_attribute => "url",
+          allow_duplicates: false,
+          callback_method: :before_validation,
+          duplicate_count_separator: "-",
+          enforce_uniqueness_on_sti_base_class: false,
+          only_when_blank: false,
+          scope_for_url: nil,
+          sync_url: false,
+          url_attribute: "url",
+          blacklist: %w[new],
+          blacklist_policy: lambda { |instance, url|
+            "#{url}-#{instance.class.to_s.downcase}"
+          }
         }.merge(Stringex::Configuration::StringExtensions.new.default_settings)
       end
     end
   end
-end
+end

data/lib/stringex/configuration/string_extensions.rb

@@ -7,13 +7,14 @@ module Stringex
 
       def self.default_settings
         @default_settings ||= {
-          :allow_slash => false,
-          :exclude => [],
-          :force_downcase => true,
-          :limit => nil,
-          :replace_whitespace_with => "-"
+          allow_slash: false,
+          exclude: [],
+          force_downcase: true,
+          limit: nil,
+          replace_whitespace_with: "-",
+          truncate_words: true
         }
       end
     end
   end
-end
+end

data/lib/stringex/core_ext.rb

@@ -0,0 +1,10 @@
+Stringex = Module.new unless defined?(Stringex)
+ensure_module_defined = ->(base, module_name){
+  base.const_set(module_name, Module.new) unless base.const_defined?(module_name)
+}
+ensure_module_defined[Stringex, :StringExtensions]
+ensure_module_defined[Stringex::StringExtensions, :PublicInstanceMethods]
+ensure_module_defined[Stringex::StringExtensions, :PublicClassMethods]
+
+String.send :include, Stringex::StringExtensions::PublicInstanceMethods
+String.send :extend, Stringex::StringExtensions::PublicClassMethods

data/lib/stringex/localization/backend/i18n.rb

@@ -5,6 +5,12 @@ module Stringex
         LOAD_PATH_BASE = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', '..', '..', 'locales')
 
         class << self
+          def reset!
+            super
+            @locale = nil
+            ::I18n.reload! if defined?(::I18n) && ::I18n.respond_to?(:reload!)
+          end
+
           def locale
             @locale || ::I18n.locale
           end
@@ -26,7 +32,7 @@ module Stringex
           end
 
           def store_translations(locale, scope, data)
-            ::I18n.backend.store_translations(locale, { :stringex => { scope => data } })
+            ::I18n.backend.store_translations(locale, {stringex: {scope => data}})
             reset_translations_cache
           end
 
@@ -41,19 +47,26 @@ module Stringex
 
           def load_translations(locale = nil)
             locale ||= self.locale
-            path = Dir[File.join(LOAD_PATH_BASE, "#{locale}.yml")]
             ::I18n.load_path |= Dir[File.join(LOAD_PATH_BASE, "#{locale}.yml")]
             ::I18n.backend.load_translations
             reset_translations_cache
           end
 
           def i18n_translations_for(locale)
-            ::I18n.translate("stringex", :locale => locale, :default => {})
+            ensure_locales_enforced_or_not
+            ::I18n.translate("stringex", locale: locale, default: {})
           end
 
           def reset_translations_cache
             @translations = nil
           end
+
+          def ensure_locales_enforced_or_not
+            return unless ::I18n.respond_to?(:enforce_available_locales)
+            # Allow users to have set this to false manually but default to true
+            return unless ::I18n.enforce_available_locales == nil
+            ::I18n.enforce_available_locales = ::I18n.available_locales != []
+          end
         end
       end