Rename public/ folder

Follow the standard Ruby structure of lib/gem_name This also helps us to understand the difference between resource_registry and schema_registry at first sight
factorialco · Nov 28, 2024 · 11f45c7 · 11f45c7
1 parent 5257b58
commit 11f45c7
Show file tree

Hide file tree

Showing 30 changed files with 34 additions and 30 deletions.
diff --git a/lib/resource_registry.rb b/lib/resource_registry.rb
@@ -3,17 +3,17 @@
 
 require "sorbet-runtime"
 
-require "public/configuration"
-require "public/resource"
-require "public/versions"
-require "public/versions/version"
-require "public/entity_finder"
+require "resource_registry/configuration"
+require "resource_registry/resource"
+require "resource_registry/versions"
+require "resource_registry/versions/version"
+require "resource_registry/entity_finder"
 require "schema_registry/json_schema_mapper"
 require "schema_registry/maybe"
 require "schema_registry/generate_from_struct"
 require "runtime_generic"
-require "public/resource_struct_builder"
-require "public/registry"
+require "resource_registry/resource_struct_builder"
+require "resource_registry/registry"
 
 # Entry point for ResourceRegistry
 module ResourceRegistry

diff --git a/lib/public/capabilities/capability_config.rb → ...egistry/capabilities/capability_config.rb b/lib/public/capabilities/capability_config.rb → ...egistry/capabilities/capability_config.rb
diff --git a/lib/public/capability_factory.rb → lib/resource_registry/capability_factory.rb b/lib/public/capability_factory.rb → lib/resource_registry/capability_factory.rb
diff --git a/lib/public/configuration.rb → lib/resource_registry/configuration.rb b/lib/public/configuration.rb → lib/resource_registry/configuration.rb
diff --git a/lib/public/entity_finder.rb → lib/resource_registry/entity_finder.rb b/lib/public/entity_finder.rb → lib/resource_registry/entity_finder.rb
diff --git a/lib/public/load_resources_from_cache.rb → ...rce_registry/load_resources_from_cache.rb b/lib/public/load_resources_from_cache.rb → ...rce_registry/load_resources_from_cache.rb
diff --git a/lib/public/registry.rb → lib/resource_registry/registry.rb b/lib/public/registry.rb → lib/resource_registry/registry.rb
diff --git a/lib/public/relationship.rb → lib/resource_registry/relationship.rb b/lib/public/relationship.rb → lib/resource_registry/relationship.rb
diff --git a/lib/public/relationship_type.rb → lib/resource_registry/relationship_type.rb b/lib/public/relationship_type.rb → lib/resource_registry/relationship_type.rb
diff --git a/lib/public/relationship_type_factory.rb → ...rce_registry/relationship_type_factory.rb b/lib/public/relationship_type_factory.rb → ...rce_registry/relationship_type_factory.rb
diff --git a/lib/public/relationship_types/belongs_to.rb → ...registry/relationship_types/belongs_to.rb b/lib/public/relationship_types/belongs_to.rb → ...registry/relationship_types/belongs_to.rb
diff --git a/lib/public/relationship_types/has_many.rb → ...e_registry/relationship_types/has_many.rb b/lib/public/relationship_types/has_many.rb → ...e_registry/relationship_types/has_many.rb
diff --git a/...ic/relationship_types/has_many_through.rb → ...ry/relationship_types/has_many_through.rb b/...ic/relationship_types/has_many_through.rb → ...ry/relationship_types/has_many_through.rb
diff --git a/lib/public/relationship_types/has_one.rb → ...ce_registry/relationship_types/has_one.rb b/lib/public/relationship_types/has_one.rb → ...ce_registry/relationship_types/has_one.rb
diff --git a/lib/public/repositories/base.rb → lib/resource_registry/repositories/base.rb b/lib/public/repositories/base.rb → lib/resource_registry/repositories/base.rb
diff --git a/lib/public/resource.rb → lib/resource_registry/resource.rb b/lib/public/resource.rb → lib/resource_registry/resource.rb
diff --git a/lib/public/resource_struct_builder.rb → ...ource_registry/resource_struct_builder.rb b/lib/public/resource_struct_builder.rb → ...ource_registry/resource_struct_builder.rb
diff --git a/lib/public/serializer.rb → lib/resource_registry/serializer.rb b/lib/public/serializer.rb → lib/resource_registry/serializer.rb
diff --git a/lib/public/verb.rb → lib/resource_registry/verb.rb b/lib/public/verb.rb → lib/resource_registry/verb.rb
diff --git a/lib/public/versions.rb → lib/resource_registry/versions.rb b/lib/public/versions.rb → lib/resource_registry/versions.rb
diff --git a/lib/public/versions/version.rb → lib/resource_registry/versions/version.rb b/lib/public/versions/version.rb → lib/resource_registry/versions/version.rb
diff --git a/lib/schema_registry/property.rb b/lib/schema_registry/property.rb
@@ -5,7 +5,7 @@
 require "bigdecimal"
 require_relative "property_type"
 require_relative "maybe"
-require_relative "../public/versions/version"
+require_relative "../resource_registry/versions/version"
 
 module SchemaRegistry
   class Property < T::Struct

diff --git a/resource_registry.gemspec b/resource_registry.gemspec
@@ -1,19 +1,23 @@
 Gem::Specification.new do |s|
-  s.name        = 'resource_registry'
-  s.version     = '0.0.0'
-  s.summary     = 'Resource Registry'
-  s.description = 'A declarative approach to define resources and their relationships'
-  s.authors     = ['Genar Trias Ortiz']
-  s.email       = '[email protected]'
-  s.files       = ['lib/resource_registry.rb', 'lib/public/repositories/base.rb', 'rbi/resource_registry.rbi']
-  s.homepage    =
-    'https://rubygems.org/gems/resource_registry'
-  s.license = 'MIT'
-  s.add_dependency 'sorbet-coerce', '>= 0.2.6'
+  s.name = "resource_registry"
+  s.version = "0.0.0"
+  s.summary = "Resource Registry"
+  s.description =
+    "A declarative approach to define resources and their relationships"
+  s.authors = ["Genar Trias Ortiz"]
+  s.email = "[email protected]"
+  s.files = %w[
+    lib/resource_registry.rb
+    lib/resource_registry/repositories/base.rb
+    rbi/resource_registry.rbi
+  ]
+  s.homepage = "https://rubygems.org/gems/resource_registry"
+  s.license = "MIT"
+  s.add_dependency "sorbet-coerce", ">= 0.2.6"
   # s.add_runtime_dependency 'sorbet-runtime-stub', '0.2.0'
-  s.add_development_dependency 'sorbet', '0.5.11609'
-  s.add_runtime_dependency 'activesupport', '>= 7.1.3'
-  s.add_runtime_dependency 'dry-inflector', '>= 0.1.2'
-  s.add_runtime_dependency 'sorbet-runtime', '0.5.11609'
+  s.add_development_dependency "sorbet", "0.5.11609"
+  s.add_runtime_dependency "activesupport", ">= 7.1.3"
+  s.add_runtime_dependency "dry-inflector", ">= 0.1.2"
+  s.add_runtime_dependency "sorbet-runtime", "0.5.11609"
   # s.add_development_dependency 'tapioca'
 end
diff --git a/spec/capability_factory_spec.rb b/spec/capability_factory_spec.rb
@@ -3,7 +3,7 @@
 
 require "spec_helper"
 require_relative "./dummy_capability"
-require_relative "../lib/public/capability_factory"
+require_relative "../lib/resource_registry/capability_factory"
 
 RSpec.describe ResourceRegistry::CapabilityFactory do
   let(:capability) { described_class }

diff --git a/spec/dummy_repo.rb b/spec/dummy_repo.rb
@@ -1,6 +1,6 @@
 # typed: false
 
-require_relative "../lib/public/repositories/base"
+require_relative "../lib/resource_registry/repositories/base"
 
 class DummyEntity < T::Struct
   const :id, Integer

diff --git a/spec/public/registry_spec.rb → spec/resource_registry/registry_spec.rb b/spec/public/registry_spec.rb → spec/resource_registry/registry_spec.rb
@@ -1,7 +1,7 @@
 # typed: false
 
 require "spec_helper"
-require_relative "../../lib/public/registry"
+require_relative "../../lib/resource_registry/registry"
 require_relative "../dummy_repo"
 
 class DummyCapability < T::Struct

diff --git a/spec/public/relationship_spec.rb → spec/resource_registry/relationship_spec.rb b/spec/public/relationship_spec.rb → spec/resource_registry/relationship_spec.rb
@@ -2,7 +2,7 @@
 # typed: false
 
 require "spec_helper"
-require_relative "../../lib/public/relationship"
+require_relative "../../lib/resource_registry/relationship"
 
 RSpec.describe ResourceRegistry::Relationship do
   describe "#load" do

diff --git a/spec/public/resource_spec.rb → spec/resource_registry/resource_spec.rb b/spec/public/resource_spec.rb → spec/resource_registry/resource_spec.rb
@@ -1,7 +1,7 @@
 # typed: false
 
 require "spec_helper"
-require_relative "../../lib/public/resource"
+require_relative "../../lib/resource_registry/resource"
 require_relative "../dummy_repo"
 require_relative "../dummy_capability"
 require_relative "../void_capability"

diff --git a/spec/public/versions_spec.rb → spec/resource_registry/versions_spec.rb b/spec/public/versions_spec.rb → spec/resource_registry/versions_spec.rb
@@ -2,7 +2,7 @@
 # typed: false
 
 require "spec_helper"
-require_relative "../../lib/public/versions"
+require_relative "../../lib/resource_registry/versions"
 
 RSpec.describe ResourceRegistry::Versions do
   subject { described_class.new(versions: versions) }

diff --git a/spec/resource_struct_builder_spec.rb b/spec/resource_struct_builder_spec.rb
@@ -2,7 +2,7 @@
 # typed: false
 
 require "spec_helper"
-require_relative "../lib/public/resource_struct_builder"
+require_relative "../lib/resource_registry/resource_struct_builder"
 
 module ResourceRegistry
   module DtoBuilderSpec