pico_api 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1191a8f8d535570f78985bbcb8fbd72c1ca6dae18c22c22721aaae7749e50d
-  data.tar.gz: ba4c1daa34d3f9dca5db1c2e3d2d617da6583b82394a62062cdbd919da7f34ab
+  metadata.gz: 80e0e5f0c73cd86d5cd7fa83de8873ffd03fbef19edcd858f1a88bfd9351d2df
+  data.tar.gz: ab141287771254c8ec7c00a8410f0edb0e83e679581ca468d072d1973b963879
 SHA512:
-  metadata.gz: a886497c3c53c5ef5d9b7a64e0598ab397bb0409411f1463c4f45ae87a601cea58577a7daded0734ecb2fedbcb0aa8c746eb915e9775fe4a2b79352e6887a85e
-  data.tar.gz: a1c7f3f41ccb615fde6814e30afeb7e88c26349e181e1d7316fb79a8129bf7a529259e29291800c29111b5ce5b69abfad694e64f76901318efe01f13c2b135dd
+  metadata.gz: 816b7ec9bd637f920faafb82a4c62307fbb1ea21b0f14ef5c87a1c6840701da6f942beef8251ee52094dbaca128967550adcdcd270ac38c9955a08c2f32d5290
+  data.tar.gz: f49ca276ea4d3e73f25ac0e54db431b189e91702463447b3a3ba6e17e862d5a8fb7d2897beaf8878b6db25fce00e08335e5fdecc7020e4b6f7f2726287915caa

data/Readme.md

@@ -40,9 +40,9 @@ Migration info: https://rom-rb.org/5.0/learn/sql/migrations/
 
 ### Routing
 
-Routing info: https://github.com/jeremyevans/roda 
+Routing info: https://github.com/jeremyevans/roda
 
-Add routing info in `config/application.rb` file 
+Add routing info in `config/application.rb` file
 
 ## Development
 - [x] Create Database config
@@ -52,6 +52,7 @@ Add routing info in `config/application.rb` file
 - [ ] Create a testing environment
 - [x] Allow multiple db gateways in the config
 - [ ] Add irb/pry console script
+- [ ] Seperate configs to different environments (dev, prod, etc..)
 
 ## Contributing
 

data/bin/pico_api

@@ -1,4 +1,3 @@
-
 #!/usr/bin/env ruby
 
 require 'optparse'
@@ -6,7 +5,7 @@ require 'pico_api'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: pico_api [options]"
+  opts.banner = 'Usage: pico_api [options]'
 
   opts.on('-n', '--new project_name') { |o| options[:project_name] = o }
 end.parse!

data/lib/pico_api/generators/commands/create_basic_structure.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module PicoApi
+  module Generators
+    module Commands
+      class CreateBasicStructure
+        def self.call(project_name)
+          project_name_converter =
+            ::PicoApi::Generators::ProjectNameConverter.new(project_name)
+
+          new(project_name_converter).call
+        end
+
+        def initialize(project_name_converter)
+          @project_name_converter = project_name_converter
+        end
+
+        def call
+          create_bin_folder
+          create_lib_folder
+          create_config_folder
+        end
+
+        private
+
+        attr_reader :project_name_converter
+
+        def create_bin_folder
+          FileUtils.mkdir_p("#{snakecased_name}/bin")
+        end
+
+        def create_lib_folder
+          FileUtils.mkdir_p("#{snakecased_name}/lib/#{snakecased_name}")
+        end
+
+        def create_config_folder
+          FileUtils.mkdir_p("#{snakecased_name}/config")
+        end
+
+        def snakecased_name
+          project_name_converter.snakecased
+        end
+      end
+    end
+  end
+end

data/lib/pico_api/generators/commands/create_config_application.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigApplication < CreateTemplate
-        private
+      class CreateConfigApplication
+        def self.call(project_name)
+          file_creator = ::PicoApi::Generators::FileCreator.build(project_name)
 
-        def destination_path
-          '/config/application.rb'
+          new(file_creator).call
+        end
+
+        def initialize(file_creator)
+          @file_creator = file_creator
+        end
+
+        def call
+          file_creator.create(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_creator
+
+        def template_file_path
           '/generators/templates/config/application.erb'
         end
+
+        def destination_path
+          '/config/application.rb'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_config_boot.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigBoot < CopyTemplate
-        private
+      class CreateConfigBoot
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/config/boot.rb'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/config/boot.erb'
         end
+
+        def destination_path
+          '/config/boot.rb'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_config_configuration.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigConfiguration < CreateTemplate
-        private
+      class CreateConfigConfiguration
+        def self.call(project_name)
+          file_creator = ::PicoApi::Generators::FileCreator.build(project_name)
 
-        def destination_path
-          '/config/configuration.rb'
+          new(file_creator).call
+        end
+
+        def initialize(file_creator)
+          @file_creator = file_creator
+        end
+
+        def call
+          file_creator.create(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_creator
+
+        def template_file_path
           '/generators/templates/config/configuration.erb'
         end
+
+        def destination_path
+          '/config/configuration.rb'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_config_database_setup.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigDatabaseSetup < CopyTemplate
-        private
+      class CreateConfigDatabaseSetup
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/config/database_setup.rb'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/config/database_setup.erb'
         end
+
+        def destination_path
+          '/config/database_setup.rb'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_config_database_yml.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigDatabaseYml < CopyTemplate
-        private
+      class CreateConfigDatabaseYml
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/config/database.yml'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/config/database.yml'
         end
+
+        def destination_path
+          '/config/database.yml'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_config_dotenv.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigDotenv < CopyTemplate
-        private
+      class CreateConfigDotenv
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/config/dotenv.rb'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/config/dotenv.erb'
         end
+
+        def destination_path
+          '/config/dotenv.rb'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_config_ru.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateConfigRu < CreateTemplate
-        private
+      class CreateConfigRu
+        def self.call(project_name)
+          file_creator = ::PicoApi::Generators::FileCreator.build(project_name)
 
-        def destination_path
-          '/config.ru'
+          new(file_creator).call
+        end
+
+        def initialize(file_creator)
+          @file_creator = file_creator
+        end
+
+        def call
+          file_creator.create(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_creator
+
+        def template_file_path
           '/generators/templates/config.ru.erb'
         end
+
+        def destination_path
+          '/config.ru'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_gemfile.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateGemfile < CopyTemplate
-        private
+      class CreateGemfile
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/Gemfile'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/Gemfile.erb'
         end
+
+        def destination_path
+          '/Gemfile'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_gitignore.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateGitignore < CopyTemplate
-        private
+      class CreateGitignore
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/.gitignore'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/.gitignore'
         end
+
+        def destination_path
+          '/.gitignore'
+        end
       end
     end
   end

data/lib/pico_api/generators/commands/create_rakefile.rb

@@ -3,16 +3,32 @@
 module PicoApi
   module Generators
     module Commands
-      class CreateRakefile < CopyTemplate
-        private
+      class CreateRakefile
+        def self.call(project_name)
+          file_copier = ::PicoApi::Generators::FileCopier.build(project_name)
 
-        def destination_path
-          '/Rakefile'
+          new(file_copier).call
+        end
+
+        def initialize(file_copier)
+          @file_copier = file_copier
+        end
+
+        def call
+          file_copier.copy(template_file_path, destination_path)
         end
 
-        def template_relative_path
+        private
+
+        attr_reader :file_copier
+
+        def template_file_path
           '/generators/templates/Rakefile.erb'
         end
+
+        def destination_path
+          '/Rakefile'
+        end
       end
     end
   end

data/lib/pico_api/generators/erb_data_handler.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'erb'
+
+module PicoApi
+  module Generators
+    class ErbDataMapper
+      def initialize(project_name_converter)
+        @snakecased_name = project_name_converter.snakecased
+        @camelcased_name = project_name_converter.camelcased
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+    class ErbDataHandler
+      def self.build(project_name_converter)
+        new(ErbDataMapper.new(project_name_converter))
+      end
+
+      def initialize(erb_data_mapper)
+        @erb_data_mapper = erb_data_mapper
+      end
+
+      def write_to_file(template_full_file_path, file)
+        file.write(
+          erb_template_file(template_full_file_path)
+            .result(erb_data_mapper.get_binding)
+        )
+      end
+
+      private
+
+      attr_reader :erb_data_mapper
+
+      def erb_template_file(template_full_file_path)
+        ERB.new(File.read(template_full_file_path))
+      end
+    end
+  end
+end

data/lib/pico_api/generators/file_copier.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module PicoApi
+  module Generators
+    class FileCopier
+      def self.build(project_name)
+        project_name_converter = ProjectNameConverter.new(project_name)
+
+        new(project_name_converter)
+      end
+
+      def initialize(project_name_converter)
+        @project_name_converter = project_name_converter
+      end
+
+      def copy(template_file_path, destination_path)
+        source_path = template_full_file_path(template_file_path)
+
+        FileUtils.cp(source_path, "#{snakecased_name}#{destination_path}")
+      end
+
+      private
+
+      attr_reader :project_name_converter
+
+      def snakecased_name
+        project_name_converter.snakecased
+      end
+
+      def template_full_file_path(template_relative_path)
+        File.join(PicoApi.lib_path, template_relative_path)
+      end
+    end
+  end
+end

data/lib/pico_api/generators/file_creator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module PicoApi
+  module Generators
+    class FileCreator
+      def self.build(project_name)
+        project_name_converter = ProjectNameConverter.new(project_name)
+        erb_data_handler = ErbDataHandler.build(project_name_converter)
+
+        new(project_name_converter, erb_data_handler)
+      end
+
+      def initialize(project_name_converter, erb_data_handler)
+        @project_name_converter = project_name_converter
+        @erb_data_handler = erb_data_handler
+      end
+
+      def create(template_file_path, destination_path)
+        File.open("#{snakecased_name}#{destination_path}", 'w') do |file|
+          create_interpolated_erb_file(template_file_path, file)
+        end
+      end
+
+      private
+
+      attr_reader :project_name_converter, :erb_data_handler
+
+      def snakecased_name
+        project_name_converter.snakecased
+      end
+
+      def create_interpolated_erb_file(template_file_path, file)
+        source_path = template_full_file_path(template_file_path)
+
+        erb_data_handler.write_to_file(source_path, file)
+      end
+
+      def template_full_file_path(template_relative_path)
+        File.join(PicoApi.lib_path, template_relative_path)
+      end
+    end
+  end
+end

data/lib/pico_api/generators/generator.rb

@@ -5,20 +5,25 @@ module PicoApi
     class Generator
       class << self
         def call(project_name)
-          commands = load_commands
-          new(project_name, commands).call
+          new(project_name, loaded_commands).call
         end
 
-        def load_commands
-          skip_commands = %w[base copytemplate createtemplate]
-
-          Dir[File.join(PicoApi.lib_path, '/generators/commands/*.rb')].sort.map do |file_path|
-            file_name = file_path.split('/').last.gsub('.rb', '').camelize
-            next if skip_commands.include?(file_name.downcase)
-
+        def loaded_commands
+          command_files.sort.map do |file_path|
+            file_name = camelized_file_name(file_path)
             "PicoApi::Generators::Commands::#{file_name}".constantize
           end.compact
         end
+
+        private
+
+        def command_files
+          Dir[File.join(PicoApi.lib_path, '/generators/commands/*.rb')]
+        end
+
+        def camelized_file_name(file_path)
+          file_path.split('/').last.gsub('.rb', '').camelize
+        end
       end
 
       def initialize(project_name, commands = [])

data/lib/pico_api/generators/project_name_converter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PicoApi
+  module Generators
+    class ProjectNameConverter
+      attr_reader :camelcased, :snakecased
+
+      def initialize(project_name)
+        @camelcased = project_name.camelize
+        @snakecased = project_name.underscore
+      end
+    end
+  end
+end

data/lib/pico_api/generators/templates/config/application.erb

@@ -1,4 +1,4 @@
-module <%= @project_name_camelcased %>
+module <%= @camelcased_name %>
   class Application < PicoApi::Application
    # Add routing instructions here. https://github.com/jeremyevans/roda
   end

data/lib/pico_api/generators/templates/config/boot.erb

@@ -1,5 +1,5 @@
 require "pico_api"
-require "./config/dotenv" if ENV['PICO_API_ENV'] == "development"
+require "./config/dotenv"
 require "./config/configuration"
 require "./config/database_setup"
 require "./config/application"

data/lib/pico_api/generators/templates/config/configuration.erb

@@ -1,9 +1,9 @@
 PicoApi.configure do |config|
   ## the base namespace of your app
-  config.namespace = "<%= @project_name_camelcased %>"
+  config.namespace = "<%= @camelcased_name %>"
 
   ## the root directory where all the business logic resides
-  config.lib_path = "lib/<%= @project_name_snakecased %>"
+  config.lib_path = "lib/<%= @snakecased_name %>"
 
   config.logger = Logger.new(STDOUT) if ENV['LOG_TO_STDOUT'] == 'true'
 

data/lib/pico_api/generators/templates/config.ru.erb

@@ -1,3 +1,3 @@
 require './config/boot'
 
-run <%= @project_name_camelcased %>::Application.freeze.app
+run <%= @camelcased_name %>::Application.freeze.app

data/lib/pico_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PicoApi
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 end

data/pico_api.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = PicoApi::VERSION
   spec.authors       = ['Alex Avlonitis']
 
-  spec.summary       = 'A tiny Rack-based ruby template for APIs'
-  spec.description   = 'A tiny Rack-based ruby template for APIs'
+  spec.summary       = 'A tiny Rack-based ruby template for building JSON-API REST APIs'
+  spec.description   = 'A tiny Rack-based ruby template for building JSON-API REST APIs'
   spec.homepage      = 'https://github.com/alexavlonitis/pico_api'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pico_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Alex Avlonitis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description: A tiny Rack-based ruby template for APIs
+description: A tiny Rack-based ruby template for building JSON-API REST APIs
 email: 
 executables:
 - pico_api
@@ -144,9 +144,7 @@ files:
 - lib/pico_api/database.rb
 - lib/pico_api/entities/error.rb
 - lib/pico_api/entities/errors.rb
-- lib/pico_api/generators/commands/base.rb
-- lib/pico_api/generators/commands/copy_template.rb
-- lib/pico_api/generators/commands/create_base.rb
+- lib/pico_api/generators/commands/create_basic_structure.rb
 - lib/pico_api/generators/commands/create_config_application.rb
 - lib/pico_api/generators/commands/create_config_boot.rb
 - lib/pico_api/generators/commands/create_config_configuration.rb
@@ -157,8 +155,11 @@ files:
 - lib/pico_api/generators/commands/create_gemfile.rb
 - lib/pico_api/generators/commands/create_gitignore.rb
 - lib/pico_api/generators/commands/create_rakefile.rb
-- lib/pico_api/generators/commands/create_template.rb
+- lib/pico_api/generators/erb_data_handler.rb
+- lib/pico_api/generators/file_copier.rb
+- lib/pico_api/generators/file_creator.rb
 - lib/pico_api/generators/generator.rb
+- lib/pico_api/generators/project_name_converter.rb
 - lib/pico_api/generators/templates/.gitignore
 - lib/pico_api/generators/templates/Gemfile.erb
 - lib/pico_api/generators/templates/Rakefile.erb
@@ -196,5 +197,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: A tiny Rack-based ruby template for APIs
+summary: A tiny Rack-based ruby template for building JSON-API REST APIs
 test_files: []

data/lib/pico_api/generators/commands/base.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'erb'
-
-module PicoApi
-  module Generators
-    module Commands
-      class Base
-        def self.call(project_name)
-          new(project_name).call
-        end
-
-        def initialize(project_name)
-          @project_name_camelcased = project_name.camelize
-          @project_name_snakecased = project_name.underscore
-        end
-
-        def call
-          NotImplementError
-        end
-
-        def get_binding
-          binding
-        end
-
-        private
-
-        attr_reader :project_name_camelised, :project_name_snakecased
-
-        def erb
-          ERB.new(File.read(template_full_path))
-        end
-
-        def template_full_path
-          File.join(PicoApi.lib_path, template_relative_path)
-        end
-
-        def template_relative_path
-          ''
-        end
-      end
-    end
-  end
-end

data/lib/pico_api/generators/commands/copy_template.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module PicoApi
-  module Generators
-    module Commands
-      class CopyTemplate < Base
-        def call
-          copy_file
-        end
-
-        private
-
-        def copy_file
-          FileUtils.cp(template_full_path, "#{project_name_snakecased}#{destination_path}")
-        end
-      end
-    end
-  end
-end

data/lib/pico_api/generators/commands/create_base.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module PicoApi
-  module Generators
-    module Commands
-      class CreateBase < Base
-        def call
-          create_bin_folder
-          create_lib_folder
-          create_config_folder
-        end
-
-        private
-
-        def create_bin_folder
-          FileUtils.mkdir_p("#{project_name_snakecased}/bin")
-        end
-
-        def create_lib_folder
-          FileUtils.mkdir_p("#{project_name_snakecased}/lib/#{project_name_snakecased}")
-        end
-
-        def create_config_folder
-          FileUtils.mkdir_p("#{project_name_snakecased}/config")
-        end
-      end
-    end
-  end
-end

data/lib/pico_api/generators/commands/create_template.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module PicoApi
-  module Generators
-    module Commands
-      class CreateTemplate < Base
-        def call
-          create_file
-        end
-
-        private
-
-        def create_file
-          File.open("#{project_name_snakecased}#{destination_path}", 'w') do |f|
-            f.write(erb.result(get_binding))
-          end
-        end
-      end
-    end
-  end
-end