lazy_names 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f594a6fa241dd756a103b41fe2a92eadfb43b0089146ae1f4499d89525a474c
+  data.tar.gz: f17a91f20eb4d7d044f682c15a1644d7da450a92b96f9902702df073ef73418b
+SHA512:
+  metadata.gz: 110cf094aaf3b4e2b726813e6c5ffb99901b020198cfa2a23bf9688661d5d5c92c561d0e37a06d453046bb64fa326c9fbe084cdfca4c4e624e792e6aa6c72295
+  data.tar.gz: 8de69d4970c6e4e2370be4803e66b0881f05df8204b0e8eb5142783877fa6e64d15ed042b57afb59329e3fddf6c7b21519a1e0486cc7b55570566f96e5d5567d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.lazy_names.tt.yml

@@ -0,0 +1,4 @@
+---
+my_awesome_project:
+  definitions:
+    'Models::Users::CreditCard': 'MUCC'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,44 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Good documentation welcome, but not required
+Style/Documentation:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled:
+    EnforcedStyle: braces
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  Enabled:
+    EnforcedStyle: indented
+
+Layout/LineLength:
+  Enabled:
+    max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/lazy_names.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lazy_names.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    lazy_names (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    fakefs (1.2.1)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fakefs (~> 1.2)
+  lazy_names!
+  pry (~> 0.13)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Zhdanov
+
+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,106 @@
+# lazy_names
+
+LazyNames helps programmer to type faster very-long classes names, constants by defining them on a shorter version.
+If you are lazy like me typing many times a day in console long constant then this gem will ease your development process.
+
+## Why
+
+Consider this example from pry terminal session.
+![Lazy names in action](https://media.giphy.com/media/7CtRJfp2yocsOu9zEA/source.gif)
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'lazy_names'
+end
+```
+2. Setup your console to automatically load lazy names
+
+- If you are using pry, add this line to `~/.pryrc` or per project `myproject/.pryrc`
+
+```ruby
+if defined?(LazyNames)
+  Pry.config.hooks.add_hook(:when_started, :lazy_names) do
+    LazyNames.load_definitions!
+  end
+end
+```
+
+- If you are using irb, add this line to `~/.irbrc` or per project `myproject/.irbrc`
+
+```ruby
+if defined?(LazyNames)
+  LazyNames.load_definitions!
+end
+```
+
+3. And then execute:
+```bash
+bundle
+```
+
+4. Create your own lazy_names config where you define constants
+```bash
+cp .lazy_names.tt.yml ~/.lazy_names.yml
+```
+
+5. Login into your rails or non-rails console
+```bash
+$ bundle exec rails c # or bin/console
+# your shorter version of constants are available now, enjoy!
+```
+
+## Configuration
+Take a look onto `lazy_names.tt.yml` it has very basic template for you to start.
+
+```yml
+---
+my_awesome_project:
+  definitions:
+    'Models::Users::CreditCard': 'MUCC'
+```
+`my_awesome_project` should be you project/folder name
+
+So consider this example:
+```sh
+$ pwd
+/Users/name/my_awesome_project
+```
+The last folder name of you ruby project must match the same one in your configuration.  
+After **definitions** sections you can actually redefine your long constants.  
+So in this example `Models::Users::CreditCard` is your real project constant and   
+`MUCC` will be your short variant of it, so you can access `Models::Users::CreditCard`   
+from `MUCC`. `MUCC` and any other right hand side can be any value, you define the best-suitable names.  
+
+You can define as many constants as you want. The same rule applies for projects.   
+Your config can have multiple constant definitions per namespace.  
+```yml
+---
+my_awesome_project:
+  definitions:
+    'Models::Users::CreditCard': 'MUCC'
+my_another_project:
+  definitions:
+    'OtherLongConst': 'Short'
+```
+
+However you can put your `.lazy_names.yml` config directly to project folder, it will be looked up firstly from project.  
+Just do not forget to put in your `.gitignore`. I believe every developer defines shorter versions of constants by his own opinion.  
+If project folder doesn't contain any `.lazy_names.yml`, it will fallback to home directory.  
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zhisme/lazy_names.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lazy_names'
+
+require 'pry'
+Pry.start

data/bin/setup

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

data/lazy_names.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_names/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'lazy_names'
+  spec.version = LazyNames::VERSION
+  spec.authors = ['zhisme']
+  spec.email = ['evdev34@gmail.com']
+
+  spec.description = <<~DESC
+    lazy_names is ruby programmer friend. You can save your time not typing long
+    error-phone constants/classes but defining short and nice versions of them.
+  DESC
+  spec.summary = 'Define short constants to frequently used classes/constants'
+  spec.homepage = 'https://github.com/zhisme/lazy_names'
+  spec.license = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.required_ruby_version = '>= 2.3.3'
+end

data/lib/lazy_names.rb

@@ -0,0 +1,21 @@
+require 'lazy_names/version'
+require 'lazy_names/find_namespace'
+require 'lazy_names/config_loader'
+require 'lazy_names/config'
+require 'lazy_names/config_validator'
+require 'lazy_names/definer'
+require 'lazy_names/logger'
+
+module LazyNames
+  def self.load_definitions!(top_level_binding = TOPLEVEL_BINDING)
+    basic_config = LazyNames::ConfigLoader
+      .(namespace: LazyNames::FindNamespace.())
+    config = LazyNames::Config.new(basic_config.definitions, basic_config.path)
+    config.validate!
+    LazyNames::Definer.(config, top_level_binding)
+
+    LazyNames::Logger.warn_undefined(config.errors.undefined, config.path)
+    LazyNames::Logger.warn_duplicate_definition(config.errors.already_defined, config.path)
+    LazyNames::Logger.warn_empty_definitions(config.constants.to_a.empty?, config.path)
+  end
+end

data/lib/lazy_names/config.rb

@@ -0,0 +1,40 @@
+module LazyNames
+  class Config
+    extend Forwardable
+
+    attr_reader :path, :validator
+
+    def_delegator :@validator, :errors
+
+    def initialize(definitions, path)
+      @definitions = definitions
+      @path = path
+      @validator = ConfigValidator.new(definitions.values, definitions.keys)
+    end
+
+    def constants
+      definitions.keys
+    end
+
+    def lazy_names
+      definitions.values
+    end
+
+    def lazy_name(name)
+      definitions[name]
+    end
+
+    def validate!
+      validator.()
+      remove_invalid_definitions!
+    end
+
+    private
+
+    def remove_invalid_definitions!
+      errors.undefined.each { |name| definitions.delete(name) }
+    end
+
+    attr_reader :definitions
+  end
+end

data/lib/lazy_names/config_loader.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+
+module LazyNames
+  class ConfigLoader
+    class NoConfig < StandardError; end
+    class ConfigNotResolved < StandardError; end
+    class NamespaceNotFound < StandardError; end
+
+    class << self
+      BasicConfig = Struct.new(:path, :definitions)
+      HOME_PATH = '~/.lazy_names.yml'.freeze
+
+      def call(namespace:, path: nil)
+        return read_from_path(namespace, path) if path
+
+        config = read_from_project(namespace)
+        config ||= read_from_home_dir(namespace)
+
+        config
+      end
+
+      private
+
+      def read_from_path(namespace, path)
+        definitions = find_definitions(path, namespace)
+
+        BasicConfig.new(path, definitions)
+      rescue Errno::ENOENT, Errno::ENOTDIR
+        raise NoConfig, "No config found by given path: #{path}"
+      end
+
+      def read_from_home_dir(namespace)
+        definitions = find_definitions(home_path, namespace)
+
+        BasicConfig.new(home_path, definitions)
+      rescue Errno::ENOENT
+        raise NoConfig, 'No config found in your home directory. ' \
+          'Create ~/.lazy_names.yml'
+      end
+
+      def read_from_project(namespace)
+        return false unless config_in_project_path?
+
+        definitions = find_definitions(project_path, namespace)
+
+        BasicConfig.new(project_path, definitions)
+      end
+
+      def find_definitions(path, namespace)
+        read_config(path)[namespace]['definitions'].to_h
+
+      rescue NoMethodError
+        raise NamespaceNotFound
+      end
+
+      def config_in_project_path?
+        File.exist?(project_path)
+      end
+
+      def read_config(path)
+        YAML.safe_load(File.read(path))
+      end
+
+      def project_path
+        File.expand_path(Pathname.new(Dir.pwd).join('.lazy_names.yml'))
+      end
+
+      def home_path
+        File.expand_path(HOME_PATH)
+      end
+    end
+  end
+end

data/lib/lazy_names/config_validator.rb

@@ -0,0 +1,59 @@
+module LazyNames
+  class ConfigValidator
+    attr_reader :errors
+
+    Errors = Struct.new(:undefined, :already_defined)
+
+    def initialize(lazy_names, constants)
+      @errors = Errors.new([], [])
+      @constants = constants
+      @lazy_names = lazy_names
+    end
+
+    def call
+      validate_constants!
+      validate_lazy_names!
+
+      self
+    end
+
+    private
+
+    attr_reader :lazy_names, :constants
+
+    def validate_constants!
+      constants.each do |c|
+        begin
+          resolve_const_in_project(c)
+        rescue NameError
+          self.errors.undefined << c
+        end
+      end
+    end
+
+    def validate_lazy_names!
+      a = lazy_names.uniq
+      b = lazy_names
+
+      diff = difference(b, a)
+
+      return unless diff
+
+      diff.each { |name| self.errors.already_defined << name }
+    end
+
+    def resolve_const_in_project(const)
+      Module.const_get(const)
+    end
+
+    def difference(arr, other)
+      copy = arr.dup
+      other.each do |e|
+        i = copy.rindex(e)
+        copy.delete_at(i) if i
+      end
+
+      copy
+    end
+  end
+end

data/lib/lazy_names/definer.rb

@@ -0,0 +1,13 @@
+module LazyNames
+  class Definer
+    class << self
+      def call(config, top_level_binding)
+        config.constants.each do |origin|
+          eval <<-RUBY, top_level_binding, __FILE__, __LINE__ + 1
+            #{config.lazy_name(origin)} = #{origin}
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/lazy_names/find_namespace.rb

@@ -0,0 +1,12 @@
+module LazyNames
+  class FindNamespace
+    class << self
+      ##
+      # Find project namespace by folder name
+      #
+      def call(path = Dir.pwd)
+        path.split('/').last
+      end
+    end
+  end
+end

data/lib/lazy_names/logger.rb

@@ -0,0 +1,48 @@
+module LazyNames
+  class Logger
+    class << self
+      def warn_undefined(errors, config_path)
+        return if errors.empty?
+
+        message = <<~MSG
+          Error loading lazy_names gem.
+          Found #{errors.size} undefined constants.
+          Please check spelling for #{errors.join(', ')}
+          #{config_path}
+          \n
+        MSG
+
+        warn(message)
+      end
+
+      def warn_duplicate_definition(errors, config_path)
+        return if errors.empty?
+
+        message = <<~MSG
+          Error loading lazy_names gem.
+          Found #{errors.size} already defined constants.
+          Using same lazy names for different constants may lead to unexpected results
+          Avoid duplications in your config file.
+          #{config_path}
+          \n
+        MSG
+
+        warn(message)
+      end
+
+      def warn_empty_definitions(errors, config_path)
+        return unless errors
+
+        message = <<~MSG
+          Error loading lazy_names gem.
+          Seems like you misspelled namespace in config.
+          #{config_path}
+          Please ensure word definitions exists in config
+          or check .lazy_names.tt.yml for consistency.
+        MSG
+
+        warn(message)
+      end
+    end
+  end
+end

data/lib/lazy_names/version.rb

@@ -0,0 +1,3 @@
+module LazyNames
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: lazy_names
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- zhisme
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  lazy_names is ruby programmer friend. You can save your time not typing long
+  error-phone constants/classes but defining short and nice versions of them.
+email:
+- evdev34@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".lazy_names.tt.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lazy_names.gemspec
+- lib/lazy_names.rb
+- lib/lazy_names/config.rb
+- lib/lazy_names/config_loader.rb
+- lib/lazy_names/config_validator.rb
+- lib/lazy_names/definer.rb
+- lib/lazy_names/find_namespace.rb
+- lib/lazy_names/logger.rb
+- lib/lazy_names/version.rb
+homepage: https://github.com/zhisme/lazy_names
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Define short constants to frequently used classes/constants
+test_files: []