named_imports 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97be320b89b4ac114bed6fb578408e92469e03ad329a9039f5cd1f3ede527d7d
+  data.tar.gz: 746036f1c888ea3c5ba714449cbe73619c510c4c0cc9f0813c63376fdad446ef
+SHA512:
+  metadata.gz: 473f6a20a5a5c2a8a6161750c4137a2ba5ff1b0bed490de4193fe89a0b50216ee7e59a975109f65ebc2113808bc646cc837cb16749a62284a8f06b19ebccdabd
+  data.tar.gz: 915c2555d3e2370d52388b8954bd254c4511f1e05c51e73687f3dacd24ddf19dc77678a53160f80d7e1b0a68c7869bf8663f52fd5e3f93f0208835d115cb3cd6

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.11
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,70 @@
+# generic stuff
+.env
+*.gem
+*.rbc
+log/*.log
+/.config
+/InstalledFiles
+/pkg/
+/tmp/
+
+# testy stuff
+.rspec
+.rspec_status
+*.orig
+/coverage/
+/coverage/
+/db/*.sqlite3
+/db/*.sqlite3-[0-9]*
+/db/*.sqlite3-journal
+/public/system
+/spec/examples.txt
+/spec/reports/
+/spec/tmp
+/test/tmp/
+/test/version_tmp/
+capybara-*.html
+pickle-email-*.html
+rerun.txt
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/storage/
+test/dummy/tmp/
+test/dummy/yarn-error.log
+
+# debuggy stuff
+.byebug_history
+
+## doccy stuff
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## bundly stuff
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# "for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments"
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# rvmmy stuff
+.rvmrc
+
+# editory stuff
+.idea
+.vscode
+*.rdb
+
+# systemy stuff
+*.swm
+*.swn
+*.swo
+*.swp
+*.DS_Store

data/.rubocop.yml

@@ -0,0 +1,96 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+# Globals
+
+AllCops:
+  NewCops: enable
+
+# Layout
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+# Metrics
+
+Metrics/AbcSize:
+  CountRepeatedAttributes: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/ClassLength:
+  Max: 150
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/MethodLength:
+  Max: 20
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/ModuleLength:
+  Max: 150
+  CountComments: false
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+# Rspec
+
+RSpec/ExampleLength:
+  Max: 25
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 10
+
+# Style
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Exclude:
+    - 'adornable.gemspec'
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kjleitz@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in named_imports.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Keegan Leitz
+
+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,165 @@
+# NamedImports
+
+Ever look at a class in a Ruby file and wonder _"Where the hell did that come from?"_ If you have, then this might ease your pain. 
+
+## Installation
+
+### Locally (to your application)
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+gem 'named_imports'
+```
+
+...and then run:
+
+```bash
+bundle install
+```
+
+### Globally (to your system)
+
+Alternatively, install it globally:
+
+```bash
+gem install named_imports
+```
+
+## Usage
+
+Require the `named_imports` gem in the entrypoint of your project, or at whatever point you know you will need named imports in Ruby files evaluated after that point:
+
+
+```rb
+require 'named_imports'
+```
+
+Then, use named imports:
+
+```rb
+# ~/your_project/lib/foo.rb
+
+class Foo
+  def self.some_bool
+    true
+  end
+end
+```
+
+```rb
+# ~/your_project/lib/example.rb
+
+from 'foo', import { Foo }
+
+Foo.some_bool
+#=> true
+```
+
+You can also specify which constant to import, which provides some safety that you don't try to access constants you haven't specified:
+
+```rb
+# ~/your_project/lib/whatever/bar_and_baz.rb
+
+class Bar
+  def self.some_int
+    123
+  end
+end
+
+class Baz
+  def self.some_str
+    "hi"
+  end
+end
+```
+
+```rb
+# ~/your_project/lib/example.rb
+
+from './whatever/bar_and_baz', import { Baz }
+
+Bar.some_int
+#=> NameError (uninitialized constant Bar)
+
+Baz.some_str
+#=> "hi"
+```
+
+> **Note:** Currently, non-specified constants defined in the imported file _will_ be available _after_ you've used one (or more) of the constants you specified in the import statement. Working on it!
+
+You can import multiple constants as well, by separating them with a semicolon in the `import` block:
+
+```rb
+# ~/your_project/lib/whatever/bam_and_bop.rb
+
+class Bam
+  def self.some_ary
+    []
+  end
+end
+
+class Bop
+  def self.some_hash
+    {}
+  end
+end
+```
+
+```rb
+# ~/your_project/lib/example.rb
+
+from 'whatever/bam_and_bop.rb', import { Bam; Bop }
+
+Bam.some_ary
+#=> []
+
+Bop.some_hash
+#=> {}
+```
+
+## TODO
+
+- [x] named constant imports
+- [x] multiple constant imports
+- [ ] top-level function imports
+- [x] namespace should not be polluted with non-specified constants (before the specified import is referenced/used)
+- [ ] namespace should not be polluted with non-specified constants (after the specified import is referenced/used)
+
+## Development
+
+### Install dependencies
+
+```bash
+bin/setup
+```
+
+### Run the tests
+
+```bash
+rake spec
+```
+
+### Run the linter
+
+```bash
+rubocop
+```
+
+### Create release
+
+```
+rake release
+```
+
+## Contributing
+
+Bug reports and pull requests for this project are welcome at its [GitHub page](https://github.com/kjleitz/named_imports). If you choose to contribute, please be nice so I don't have to run out of bubblegum, etc.
+
+## License
+
+This project is open source, under the terms of the [MIT license.](https://github.com/kjleitz/named_imports/blob/master/LICENSE)
+
+## Code of Conduct
+
+Everyone interacting in the NamedImports project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kjleitz/named_imports/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "named_imports"
+
+# 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(__FILE__)

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/lib/named_imports.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "named_imports/version"
+
+module NamedImports
+  class Error < StandardError; end
+
+  class << self
+    def from(path, constants)
+      ext = %r{[^/]+\.[^/]+$}.match?(path) ? "" : ".rb"
+      path_with_ext = "#{path}#{ext}"
+      caller_dir = File.dirname(caller(2..2).first)
+      full_path = File.expand_path(path_with_ext, caller_dir)
+
+      constants.each do |constant_name|
+        Object.send(:remove_const, constant_name.to_sym)
+        Object.autoload constant_name.to_sym, full_path
+      end
+    end
+
+    def import
+      constants = []
+
+      begin
+        yield
+      rescue NameError => e
+        raise e unless /uninitialized constant /.match?(e.message)
+
+        constant_name = e.message.gsub(/uninitialized constant /, '').to_s
+        already_there = constants.include?(constant_name)
+
+        unless already_there
+          constants << constant_name
+          Object.const_set(constant_name, nil)
+        end
+
+        retry
+      end
+
+      constants
+    end
+  end
+
+  Kernel.define_method(:from) do |path, constants|
+    NamedImports.from(path, constants)
+  end
+
+  Kernel.define_method(:import) do |&block|
+    NamedImports.import(&block)
+  end
+end

data/lib/named_imports/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NamedImports
+  VERSION = "0.1.0"
+end

data/named_imports.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/named_imports/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "named_imports"
+  spec.version = NamedImports::VERSION
+  spec.authors = ["Keegan Leitz"]
+  spec.email = ["kjleitz@gmail.com"]
+
+  spec.summary = "Named imports for Ruby"
+  spec.description = "Stop asking where that thing came from."
+  spec.homepage = "https://github.com/kjleitz/named_imports"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kjleitz/named_imports"
+  spec.metadata["changelog_uri"] = "https://github.com/kjleitz/named_imports/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # `git ls-files -z` loads the files in the RubyGem that are tracked in git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.10"
+  spec.add_development_dependency "rubocop-performance", "~> 1.9"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.2"
+  spec.add_development_dependency "solargraph"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: named_imports
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keegan Leitz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  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: Stop asking where that thing came from.
+email:
+- kjleitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/named_imports.rb
+- lib/named_imports/version.rb
+- named_imports.gemspec
+homepage: https://github.com/kjleitz/named_imports
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kjleitz/named_imports
+  source_code_uri: https://github.com/kjleitz/named_imports
+  changelog_uri: https://github.com/kjleitz/named_imports/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Named imports for Ruby
+test_files: []