lazy_names 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2f594a6fa241dd756a103b41fe2a92eadfb43b0089146ae1f4499d89525a474c
-  data.tar.gz: f17a91f20eb4d7d044f682c15a1644d7da450a92b96f9902702df073ef73418b
+SHA1:
+  metadata.gz: 7d0986ae45e667f52744c72afa5c79ed9adadd84
+  data.tar.gz: bfce318aab2ff6de0cf1a2147dc334011d03bab0
 SHA512:
-  metadata.gz: 110cf094aaf3b4e2b726813e6c5ffb99901b020198cfa2a23bf9688661d5d5c92c561d0e37a06d453046bb64fa326c9fbe084cdfca4c4e624e792e6aa6c72295
-  data.tar.gz: 8de69d4970c6e4e2370be4803e66b0881f05df8204b0e8eb5142783877fa6e64d15ed042b57afb59329e3fddf6c7b21519a1e0486cc7b55570566f96e5d5567d
+  metadata.gz: cfc61aaa924dbd3c67221000f7d38ac0445cc43fe8b14a3c16e9d8ea70dd5b40d95553d98e38777b5212ec7765c40d0155051dfc594347f8132f2f76091c2840
+  data.tar.gz: 5002c013d4d4537aeb12addace4a0c77001a655ca888e835e6344b0f5f1a5d1c946d122f333a7638cf5381d426b487f4031ee3fb8ba5948d2b182690970ac569

data/.lazy_names.tt.project.yml

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

data/Gemfile.lock

@@ -1,14 +1,13 @@
 PATH
   remote: .
   specs:
-    lazy_names (0.0.1)
+    lazy_names (0.2.0)
 
 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)
@@ -33,7 +32,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  fakefs (~> 1.2)
   lazy_names!
   pry (~> 0.13)
   rake (~> 10.0)

data/README.md

@@ -1,7 +1,7 @@
 # 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.
+LazyNames helps programmer to type faster very-long class names, constants by defining them on a shorter version.
+If you are lazy like me typing many times a day in console long constants then this gem will ease your development process.
 
 ## Why
 
@@ -54,6 +54,9 @@ $ bundle exec rails c # or bin/console
 ```
 
 ## Configuration
+
+### Global definition
+
 Take a look onto `lazy_names.tt.yml` it has very basic template for you to start.
 
 ```yml
@@ -69,14 +72,14 @@ So consider this example:
 $ 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.  
+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:
@@ -87,9 +90,22 @@ my_another_project:
     '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.  
+### Project definitions
+
+In the meantime 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.
+```sh
+echo '.lazy_names.yml' >> .gitignore
+```
+If project folder doesn't contain any `.lazy_names.yml`, it will fallback to home directory.
+
+Configuration per project a bit different: you don't need to specify global scope `my_awesome_project`, you can skip forward to definitions
+```yml
+---
+definitions:
+  'Models::Users::CreditCard: 'MUCC'
+```
+Example config can be found in `.lazy_names.tt.project.yml`
 
 ## Development
 

data/lib/lazy_names/config_loader.rb

@@ -5,6 +5,7 @@ module LazyNames
     class NoConfig < StandardError; end
     class ConfigNotResolved < StandardError; end
     class NamespaceNotFound < StandardError; end
+    class NoDefinitions < StandardError; end
 
     class << self
       BasicConfig = Struct.new(:path, :definitions)
@@ -13,7 +14,7 @@ module LazyNames
       def call(namespace:, path: nil)
         return read_from_path(namespace, path) if path
 
-        config = read_from_project(namespace)
+        config = read_from_project if config_in_project_path?
         config ||= read_from_home_dir(namespace)
 
         config
@@ -38,19 +39,33 @@ module LazyNames
           'Create ~/.lazy_names.yml'
       end
 
-      def read_from_project(namespace)
-        return false unless config_in_project_path?
-
-        definitions = find_definitions(project_path, namespace)
+      def read_from_project
+        definitions = find_project_definitions
 
         BasicConfig.new(project_path, definitions)
       end
 
+      def find_project_definitions
+        read_config(project_path)['definitions'].to_hash
+
+      rescue NoMethodError
+        raise NoDefinitions, "No definitions found in #{project_path}. " \
+          'See config example .lazy_names.tt.project.yml'
+      end
+
       def find_definitions(path, namespace)
-        read_config(path)[namespace]['definitions'].to_h
+        find_namespace_contents(path, namespace)['definitions'].to_hash
+
+      rescue NoMethodError
+        raise NoDefinitions, "No definitions found in #{path}. " \
+          'See config example in .lazy_names.tt.yml'
+      end
 
+      def find_namespace_contents(path, namespace)
+        read_config(path)[namespace].to_hash
       rescue NoMethodError
-        raise NamespaceNotFound
+        raise NamespaceNotFound, "No namespace found in #{path}. " \
+          'See config example in .lazy_names.tt.yml and check README'
       end
 
       def config_in_project_path?

data/lib/lazy_names/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_names
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - zhisme
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".lazy_names.tt.project.yml"
 - ".lazy_names.tt.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -116,7 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project:
+rubygems_version: 2.5.2
 signing_key:
 specification_version: 4
 summary: Define short constants to frequently used classes/constants