intact_case 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c442c08b6d97048564ccc099f9156259db55496a
+  data.tar.gz: f9fcfbf4d9b3147c3b4e1f029a9a4e00c7f5048b
+SHA512:
+  metadata.gz: 3bff45e27e7a2b7eb140010a60d26bc59dd8615db95361256e77511bfca94d4f7b3e4b728e7b8aea401284bfd6db2a59291f7bc5f7dc1d29b4d9bdab0a35be2d
+  data.tar.gz: 14a4ee350ca69901716d03820ac0d130ea0e34a8b169f5912bedf58a39e1281b5c7740f6ac7916b4f15977fc08e1c02d49de74135c76041373cee979a16550a4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in intact_case.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Intact Case : Natural interconversion for camelCase and snake_case with acronym.
+Copyright (c) 2015 Stew Eucen (http://lab.kochlein.com)
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Intact Case for Ruby
+
+## What's Intact Case
+
+Intact Case is the rules for interconverting naturally camelCase|StudlyCaps and snake_case which include acronym.
+
+camelCase / StudlyCaps|snake_case
+----|----
+camelCase|camel_case
+SnakeCase|snake_case
+PHPUnit|php__unit
+getUTCDay|get_utc__day
+
+This library can interconvert camelCase|StudlyCaps and hyphenated string.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'intact_case'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install intact_case
+
+## Usage
+
+When you use this library, you must understand rules of Intact Case.
+
+If you want to see more information, please see [IntactCase](http://lab.kochlein.com/IntactCase).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/StewEucen/intact-case-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "intact_case"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/intact_case.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'intact_case/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "intact_case"
+  spec.version       = IntactCase::VERSION
+  spec.authors       = ["Stew Eucen"]
+  spec.email         = ["stew.eucen@gmail.com"]
+
+  spec.summary       = %q{Reversible convertor for camelCase and snake_case which has acronyms.}
+  spec.description   = %q{When camelCase has acronyms, can convert it to snake_case, however it can not be converted to original camelCase with intact acronyms. Rules of Intact Case is the solution for this problem.}
+  spec.homepage      = "http://lab.kochlein.com/IntactCase"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    ### spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/intact_case/modules.rb

@@ -0,0 +1,268 @@
+#
+# Intact Case for Ruby
+# Interconverting camelCase and snake_case which include acronym.
+#
+# @author StewEucen
+# @copyright Copyright (c) 2015 Stew Eucen (http://lab.kochlein.com)
+# @license   http://www.opensource.org/licenses/mit-license.php  MIT License
+#
+# @link       http://lab.kochlein.com/IntactCase
+# @since      File available since Release 1.0.0
+# @version    1.0.0
+#
+module StewEucen
+  # Name space of Stew Eucen's Acts
+  module Acts
+    # Name space of Intact Case
+    module IntactCase
+
+      #
+      # Methods to include into String class.
+      #
+      # @author StewEucen
+      # @example Include into String class.
+      #   String.send :include, StewEucen::Acts::IntactCase::String
+      # @since  Release 1.0.0
+      #
+      module String
+
+        #
+        # Convert compound words to camelCase from delimiterized.
+        #
+        # @author StewEucen
+        # @example delimiterized to camelCase.
+        #   'snake_case'.camelize         #=> 'snakeCase'
+        #   'get_utc__day'.camelize       #=> 'getUTCDay'
+        #   'ui__view'.camelize           #=> 'ui_View'
+        #   'xml__html__request'.camelize #=> 'xml_HTMLRequest'
+        # @param  [string] delimiter Delimiter.
+        # @return [string] camelCase String.
+        # @since  Release 1.0.0
+        #
+        def camelize(delimiter = '_')
+          d = Regexp.escape(delimiter)
+
+          camel_head    = "^([a-z]{2,}#{d})(?:#{d}|$)"  # can not use (?![a-z]) because (?:)
+          capitalize    = "(?<=#{d})([a-z])"
+          rear_acronym  = "(?!^)([a-z]+)#{d}(?![a-z])"
+          cut_delimiter = "(?<=^|[a-z]{2})#{d}|#{d}(?=[a-z]{2,}(?:#{d}[a-z]|$))"
+
+          cases_pattern = /#{camel_head}|#{capitalize}|#{rear_acronym}|#{cut_delimiter}/
+          self.gsub(cases_pattern) { "#{$1}" + "#{$2}#{$3}".upcase }
+        end
+
+        #
+        # Convert compound words to StudlyCaps from delimiterized string.
+        #
+        # @author StewEucen
+        # @example delimiterized to StudlyCaps.
+        #   'snake_case'.studly_caps         #=> 'SnakeCase'
+        #   'get_utc__day'.studly_caps       #=> 'GetUTCDay'
+        #   'ui__view'.studly_caps           #=> 'UIView'
+        #   'xml__html__request'.studly_caps #=> 'XML_HTMLRequest'
+        # @param  [string] delimiter Delimiter.
+        # @return [string] StudlyCaps string.
+        # @since  Release 1.0.0
+        #
+        def studly_caps(delimiter = '_')
+          ((self.start_with?(delimiter) ? '' : delimiter) + self).camel_case(delimiter)
+        end
+
+        #
+        # Convert compound words connected by a delimiter from camelCase|StudlyCaps.
+        #
+        # @author StewEucen
+        # @example camelCase|StudlyCaps to delimiterized.
+        #   'camelCase'.delimiterize             #=> 'camel_case'
+        #   'StudlyCaps'.delimiterize('_', true) #=> '_studly_caps'
+        #   'chainCase'.delimiterize('-')        #=> 'chain-case'
+        #   'getUTCDay'.delimiterize             #=> 'get_utc__day'
+        #   'UIView'.delimiterize                #=> 'ui__view'
+        #   'XML_HTMLRequest'.delimiterize       #=> 'xml__html__request'
+        # @param  [string] delimiter Concatenate tokens with between delimiter.
+        # @param  [boolean] as_vendor_prefix Treat as vendor-prefix (CSS).
+        # @return [string] Delimiterized compound words.
+        # @since  Release 1.0.0
+        #
+        def delimiterize(delimiter = '_', as_vendor_prefix = false)
+          d = Regexp.escape(delimiter)
+
+          before_acronym = "(?:^[a-z]{2,}#{d}|[a-z])(?=[A-Z](?![a-z]))"
+          after_acronym  = "[A-Z]{2,}(?![a-z])"
+          before_capital = "(?!^)(?=[A-Z][a-z])"
+          p = /#{before_acronym}|#{after_acronym}|#{before_capital}/;
+
+          head_delimiter = as_vendor_prefix && /^[A-Z]/ =~ self ? delimiter : ''
+          head_delimiter + self.gsub(p) { $& + delimiter }.downcase
+        end
+
+        #
+        # Hyphenate compound words from camelCase|StudlyCaps.
+        #
+        # @author StewEucen
+        # @example camelCase|StudlyCaps to hyphenated string.
+        #   'chainCase'.hyphenated          #=> 'chain-case'
+        #   'VendorPrefix'.hyphenated(true) #=> '-vendor-prefix'
+        #   'camelCase'.hyphenated(true)    #=> 'camel-case'
+        # @param  [boolean] as_vendor_prefix Treat as vendor-prefix (CSS).
+        # @return [string] Hyphenated string.
+        # @since  Release 1.0.0
+        #
+        def hyphenated(as_vendor_prefix = false)
+          self.delimiterize('-', as_vendor_prefix)
+        end
+
+        #
+        # Explode compound words to tokens.
+        #
+        # @author StewEucen
+        # @example Tokens from compound words.
+        #   'camelCase'.tokenize            #=> ['Camel', 'Case']
+        #   'camelCase'.tokenize('_', true) #=> ['camel', 'Case']
+        #   'StudlyCaps'.tokenize           #=> ['Studly', 'Caps']
+        #   'snake_case'.tokenize           #=> ['snake', 'case']
+        #   'get_utc__day'.tokenize         #=> ['get', 'utc_', 'day']
+        # @param  [string] delimiter Delimiter.
+        # @param  [boolean] raw_first Keep raw first word in tokens for camelCase.
+        # @return [array] Tokens except delimiter between acronym.
+        # @see    _tokenize_from_camelized, _tokenize_from_delimiterized
+        # @since  Release 1.0.0
+        #
+        def tokenize(delimiter = '_', raw_first = false)
+          if /[A-Z]/ =~ self then
+            _tokenize_from_camelized(delimiter, raw_first)
+          else
+            _tokenize_from_delimiterized(delimiter)
+          end
+        end
+
+        private
+
+          #
+          # Tokenize compound words from camelCase|StudlyCaps.
+          #
+          # @author StewEucen
+          # @param  [string] delimiter Delimiter between acronym.
+          # @param  [boolean] raw_first Keep raw first word in tokens for camelCase.
+          # @return [array] Tokens except delimiter between acronym.
+          # @since  Release 1.0.0
+          #
+          def _tokenize_from_camelized(delimiter, raw_first)
+            d = Regexp.escape(delimiter)
+            p = /(?:[A-Z]+|[A-Z]?(?:[a-z]{2,}#{d}?|[a-z]))(?![a-z])/;
+            # (?:                              : token body
+            #   [A-Z]+                         : acronym
+            #   |                              : or
+            #   [A-Z]?(?:[a-z]{2,}#{d}?|[a-z]) : usual word|first in camelCase|
+            # )
+            # (?![a-z])                        : break word same as (?=[A-Z]|_|$)
+            tokens = self.scan(p)
+
+            # Upcase for acronym of first word in camelCase.
+            tokens[0] = tokens[0].studly_caps(delimiter) unless raw_first
+
+            tokens
+          end
+
+          #
+          # Tokenize compound words from delimiterized.
+          #
+          # @author StewEucen
+          # @param  [string] delimiter Delimiter.
+          # @return [array] Tokens except delimiter between acronym.
+          # @since  Release 1.0.0
+          #
+          def _tokenize_from_delimiterized(delimiter)
+            d = Regexp.escape(delimiter)
+            p = /[a-z]+#{d}?(?![a-z])/
+
+            self.scan(p).compact
+          end
+
+        public
+
+        #
+        # Capitalize first word in compound words.
+        # When first word is acronym, convert it to StudlyCaps.
+        #
+        # @author StewEucen
+        # @example StudlyCaps from camelCase
+        #   'camelCase'.uc_first       #=> 'CamelCase'
+        #   'xml_HTMLRequest'.uc_first #=> 'XML_HTMLRequest'
+        # @param  [string] delimiter Delimiter after acronym.
+        # @return [string] StudlyCaps (= capitalized camelCase).
+        # @since  Release 1.0.0
+        #
+        def uc_first(delimiter = '_')
+          self.delimiterize(delimiter).studly_caps(delimiter)
+        end
+
+        #
+        # Uncapitalize first word in compound words.
+        # When first word is acronym, convert it to delimiterized string.
+        #
+        # @author StewEucen
+        # @example camelCase from StudlyCaps
+        #   'StudlyCaps'.lc_first #=> 'studlyCaps'
+        #   'UIView'.lc_first     #=> 'ui_View'
+        # @param  [string] delimiter Delimiter after acronym.
+        # @return [string] camelCase (= uncapitalized StudlyCaps).
+        # @since  Release 1.0.0
+        #
+        def lc_first(delimiter = '_')
+          self.delimiterize(delimiter).camelize(delimiter)
+        end
+
+        #
+        # a.k.a.
+        #
+        alias_infos = {
+              camelize: [:nerd_caps, :camel_case],
+           studly_caps: [:pascal_case],
+          delimiterize: [:snake_case, :underscored],
+            hyphenated: [:train_case, :chain_case, :kebab_case, :spinal_case],
+        }
+
+        alias_infos.each_pair do |origin_name, alias_names|
+          alias_names.each { |alias_name| alias_method alias_name, origin_name }
+        end
+      end
+
+      #
+      # Methods to include into Array class.
+      #
+      # @author StewEucen
+      # @example Include into String class.
+      #   Array.send :include, StewEucen::Acts::IntactCase::Array
+      # @since  Release 1.0.0
+      #
+      module Array
+
+        #
+        # Concatenate tokens (camelCase/StudlyCaps/snake_case).
+        #
+        # @author StewEucen
+        # @example tokens from snake_case
+        #   ['camel', 'Case'].compound           #=> 'camelCase'
+        #   ['Studly', 'Caps'].compound          #=> 'StudlyCaps'
+        #   ['XML', 'HTML', 'Request'].compound  #=> 'XML_HTMLRequest'
+        #   ['get', 'utc_', 'day'].compound      #=> 'get_utc__day'
+        #   ['', 'webkit', 'flex'].compound('-') #=> '-webkit-flex'
+        # @param  [string] delimiter Delimiter between acronym.
+        # @return [string] camelCase/StudlyCaps/snake_case.
+        # @since  Release 1.0.0
+        #
+        def compound(delimiter = '_')
+          compounded = self.join(delimiter)
+          # When snake_case.
+          return compounded if /[A-Z]/ !~ compounded
+
+          d = Regexp.escape(delimiter)
+          p = /(?<=.[a-z])#{d}|(?<!#{d})#{d}(?=[A-Z][a-z])/
+          compounded.gsub(p, '')
+        end
+      end
+
+    end
+  end
+end

data/lib/intact_case/version.rb

@@ -0,0 +1,3 @@
+module IntactCase
+  VERSION = '1.0.0'
+end

data/lib/intact_case.rb

@@ -0,0 +1,5 @@
+require 'intact_case/version'
+require 'intact_case/modules'
+
+String.send :include, StewEucen::Acts::IntactCase::String
+Array .send :include, StewEucen::Acts::IntactCase::Array

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: intact_case
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stew Eucen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: When camelCase has acronyms, can convert it to snake_case, however it
+  can not be converted to original camelCase with intact acronyms. Rules of Intact
+  Case is the solution for this problem.
+email:
+- stew.eucen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- intact_case.gemspec
+- lib/intact_case.rb
+- lib/intact_case/modules.rb
+- lib/intact_case/version.rb
+homepage: http://lab.kochlein.com/IntactCase
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Reversible convertor for camelCase and snake_case which has acronyms.
+test_files: []