faker-shorthand 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0a7fe67d0f0cfde1e35d173e9bcbb7a43d6b72277ea0de074c58cecc09f8946
+  data.tar.gz: a6bad53bd0cbacfa1d24488c94e039beabafde55a3ef4e53dc4ca8f34906a5ec
+SHA512:
+  metadata.gz: b03c877c798f14aeab2accce8b3063e6c2e33160e4c35c76cf0048b2de04530952fde27e4643fdb2bd65577de1c21d83a46a5633516666502571d61874892b34
+  data.tar.gz: dd4d149f3d4e0573388d60a9180ca7e5d03a038020a170f0d13feaf95aa47ec6778e71bf76d96bacd74b93c260bc2300c595ce298fa418f5ef51b72d9aa7d7a2

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at acuppy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in faker_shorthand.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem 'guard' # NOTE: this is necessary in newer versions
+gem 'guard-minitest'
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    faker_shorthand (0.1.0)
+      faker
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    faker (3.1.1)
+      i18n (>= 1.8.11, < 2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker_shorthand!
+  guard
+  guard-minitest
+  minitest (~> 5.0)
+  pry
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Adam Cuppy
+
+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,77 @@
+# Faker::Shorthand (for Ruby)
+
+:tired_face: Tied of writing `Faker::Name.name` over and over again?! Me too. But, you're in luck :smile:, there's a app (gem) for that! With `Faker::Shorthand`, you too can save your shift-key and milliseconds of exta keyboarding...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faker-shorthand'
+```
+
+Then execute:
+
+    $ bundle install
+
+And last, but not least, add to your preferred test_helper (along with Faker itself):
+
+```ruby
+require 'faker/shorthand'
+```
+
+## Usage
+
+Instead of `Faker::ChuckNorris.fact` simply write `f.chuck_norris.fact` and :boom: you get everything you've ever wanted (...from that Faker module). The mapping is quite simple.
+
+We have support for single and multiword modules and methods!
+
+In case you're worried, we won't lose those all so valuable keyword and method arguments. Just pass those along, and _we will too_. 
+
+Let our Faker methods be your Faker methods.
+
+## :question: Never Asked Questions:
+
+- "WHAT IF I HATE SHORTHAND?!" No problem. You can use your trusty shift-key to write out all of those capitalized module/class declarations.
+
+- "Hmmm, what about my custom Faker extension?" No problem. It's just shorthand. We don't override any modules. If your version of Faker has it, so do we!
+
+- "I use FactoryBot, can I integrate this glorious shorthand?" Of course - do you think we'd forget about you! No silly human. With one line of code in your `test_helper` of choice and you have shorthand everywhere!!
+
+## FactoryBot integration
+
+Include the following line in your preferred test_helper _after_ requiring FactoryBot:
+
+```ruby
+class FactoryBot::SyntaxRunner
+  include Faker::Shorthand::Methods
+end
+```
+
+## Coming soon (launching 2023/4/5-ish)
+
+### Aliases
+Shorten the shorthand with a single line of configuration, `f.name.name` will become `f.name`, and `f.name.first_name` to become `f.name.first`.
+
+### Compositions
+Who loves combining strings anyways?! Not us at the Institute of Faker::Shorthand. With a touch of configuration, we can make all of that go away. Ask for `f.name.first.and.last` and you've made `"#{Faker::Name.first_name} #{Faker::Name.last_name}` and thing of the past. (This may be a horrible idea. It's not entirely clear at this point.)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/faker_shorthand. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/faker_shorthand/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FakerShorthand project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/faker_shorthand/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faker_shorthand"
+
+# 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/faker_shorthand.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/faker/shorthand'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faker-shorthand"
+  spec.version       = Faker::Shorthand::VERSION
+  spec.authors       = ["Adam Cuppy"]
+  spec.email         = ["acuppy@hey.com"]
+
+  spec.summary       = %q{Shorthand for the Faker generator syntax}
+  spec.description   = %q{Shorthand for the Faker generator syntax}
+  spec.homepage      = "https://github.com/acuppy/faker_shorthand"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/acuppy/faker_shorthand"
+  spec.metadata["changelog_uri"] = "https://github.com/acuppy/faker_shorthand"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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_dependency 'faker'
+end

data/lib/faker/shorthand/matcher.rb

@@ -0,0 +1,55 @@
+module Faker
+  module Shorthand
+    class Matcher
+      def initialize
+        @klass  = nil
+        @method = nil
+      end
+    
+      def method_missing(method, **args, &block)
+        unless @klass
+          catch_module_errors { define_faker_class(method) }
+          self
+        else
+          catch_method_errors { send_faker_method(method, **args, &block) }
+        end
+      end
+    
+      private
+    
+        def assert_method?(method)
+          @klass.methods(false).include? method.to_sym
+        end
+
+        def classify(klass)
+          klass.to_s.split('_').collect(&:capitalize).join
+        end
+        
+        def catch_module_errors(&block)
+          block.call
+        rescue NameError, TypeError => e
+          raise MatcherModuleError.new(e)
+        end
+
+        def catch_method_errors(&block)
+          block.call
+        rescue ArgumentError => e
+          raise MatcherArgumentError.new(@klass_name, @method, e)
+        end
+
+        def define_faker_class(klass_name)
+          @klass_name = classify(klass_name)
+          @klass ||= Faker.const_get(@klass_name)
+        end
+
+        def send_faker_method(method, **args, &block)
+          unless assert_method?(method)
+            raise MatcherMethodError.new(@klass_name, method)
+          end
+          
+          @method = method
+          @klass.public_send(@method, **args, &block)
+        end
+    end
+  end
+end

data/lib/faker/shorthand/methods.rb

@@ -0,0 +1,11 @@
+module Faker
+  module Shorthand
+    module Methods
+      def fake
+        Faker::Shorthand::Matcher.new
+      end
+    
+      alias_method :f, :fake
+    end
+  end
+end

data/lib/faker/shorthand.rb

@@ -0,0 +1,26 @@
+require_relative "shorthand/matcher"
+require_relative "shorthand/methods"
+
+module Faker
+  module Shorthand
+    VERSION = "0.1.0"
+
+    class MatcherModuleError < StandardError
+      def initialize(module_name)
+        super "No Faker module matches Faker::#{module_name}"
+      end
+    end
+  
+    class MatcherMethodError < NoMethodError
+      def initialize(module_name, method_name)
+        super "No generator method matches Faker::#{module_name}.#{method_name}"
+      end
+    end
+  
+    class MatcherArgumentError < ArgumentError
+      def initialize(module_name, method_name, e)
+        super "Faker::#{module_name}.#{method_name}: #{e}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: faker-shorthand
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Cuppy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shorthand for the Faker generator syntax
+email:
+- acuppy@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faker_shorthand.gemspec
+- lib/faker/shorthand.rb
+- lib/faker/shorthand/matcher.rb
+- lib/faker/shorthand/methods.rb
+homepage: https://github.com/acuppy/faker_shorthand
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/acuppy/faker_shorthand
+  source_code_uri: https://github.com/acuppy/faker_shorthand
+  changelog_uri: https://github.com/acuppy/faker_shorthand
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Shorthand for the Faker generator syntax
+test_files: []