svrless 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa4ee241942179aafc8a3afdeb61575f273ca3602cf6ca00f3b3fceab4c7417b
-  data.tar.gz: 1211b439d3251317f88183f6602318b10e192afc990006d88d9da04b1ef79203
+  metadata.gz: 87beb4ab1add30ff48878fb595f0fc4a9d4fbdb2a6e8cfb93bd74e86b11726ae
+  data.tar.gz: 278431e393d27ef935b22b52d5df8148c403118698af9a8dd0c37417313b9796
 SHA512:
-  metadata.gz: ec5e5621c3878e06748773898bb2a181446e6d8235a96a0f949aae36415eec4fe37211f03e6a4b6e609f7f595291044deba3256dae8c58031714fce08be2d85e
-  data.tar.gz: a01d89cf80dc8f6bdb65608af7148f446138f1247009bc715c46a4da85b401d2443aa5d297704d43abb4a587d0172c519b755c38c3bd91105254e5fba36b7c6d
+  metadata.gz: 7d1c9156e07022fe049ec8648edda5d3fc364db5056b5bd89a981d3c05352ab9fbe54c7606aaa7feaa0a9705749f45c50890bf261897f46dcece2ad0df8b7d3d
+  data.tar.gz: a9659b5bd8c304b0a0d07ea5a429e5b0a7e85697e8d2f8c583064df34adad0a6c0ab428695dcea7059feb342cb8cf3b97c260e6e4480cf0af2b742f9946d8bc3

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.2.0]- 2021-02-14
+
+- Template generation is cleaner now.
+- Replace Event with ResourceGenerator class.
+- Moved template formation from ResourceGenerator into various generator classes.
+- Added tests to cover these.
+
+## [0.1.1] - 2021-02-14
+
+- Minor improvements to initial set up
+
 ## [0.1.0] - 2021-02-11
 
 - Initial release

data/README.md

@@ -34,7 +34,7 @@ To create a new svrless project
     
     $ svrless
 
-    # uncomment the posts resource in routes 
+    # uncomment the resources in routes
 
     $ ruby config/routes.rb 
 
@@ -46,6 +46,14 @@ To create a new svrless project
 
     $ make a POST request to http://localhost:3000/posts to see your lambda in action
 
+### Routes
+
+The routes file accepts a list of resources in their singular form i.e
+
+`resources :post, :comment, :user`
+
+This will create controllers for those resources with routing mechanics in the SAM validated template.yaml.
+
 ## 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.

data/bin/svrless

@@ -25,9 +25,9 @@ File.open("config/routes.rb", "w") do |f|
   f.write "require 'svrless'\n"
   f.write "\n"
   f.write "class Routes\n"
-  f.write "  include Event\n"
+  f.write "  include ResourceGenerator\n"
   f.write "\n"
-  f.write "  # resource :post\n"
+  f.write "  # resources :post, :comment\n"
   f.write "end\n"
 end
 

data/lib/svrless.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require "active_support/all"
+require "yaml"
+
 require_relative "svrless/version"
-require_relative "svrless/event"
+require_relative "svrless/resource_generator"
+require_relative "svrless/generators/cloud_formation/main_generator"
 
 module Svrless
   class Error < StandardError; end

data/lib/svrless/generators/cloud_formation/event_generator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "svrless"
+
+module CloudFormation
+  # Responsible for generating a hash which will eventually look like this:
+  # Create:
+  #   Type: Api
+  #   Properties:
+  #     Method: post
+  #     Path: "/posts"
+  #
+  # Input: klass: Class, action: :show
+  # Input: klass: Post, action: :update
+  class EventGenerator
+    attr_accessor :klass, :action
+
+    def initialize(klass:, action:)
+      @klass = klass
+      @action = action
+    end
+
+    def hash_representation
+      {
+        "#{@action}": {
+          type: "Api",
+          properties: {
+            method: http_method,
+            path: api_path
+          }
+        }
+      }
+    end
+
+    def http_method
+      case @action
+      when :create
+        "post"
+      when :show
+        "get"
+      when :update
+        "put"
+      else
+        "delete"
+      end
+    end
+
+    def api_path
+      return "/#{restify_klass_name}" if @action == :create
+
+      "/#{restify_klass_name}/{id}"
+    end
+
+    def restify_klass_name
+      @klass.to_s.underscore.pluralize.dasherize
+    end
+  end
+end

data/lib/svrless/generators/cloud_formation/function_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "svrless"
+
+require_relative "event_generator"
+
+module CloudFormation
+  # Responsible for generating a hash which will eventually look like this:
+  class FunctionGenerator
+    attr_accessor :klass, :actions
+
+    def initialize(klass:, actions:)
+      @klass = klass
+      @actions = actions
+    end
+
+    def hash_representation
+      {
+        "#{plural_klass_name}_controller": {
+          type: "AWS::Serverless::Function",
+          properties: properties_hash
+        }
+      }
+    end
+
+    private
+
+    def properties_hash
+      {
+        code_uri: "app/functions/#{plural_klass_name}",
+        events: events_hash,
+        function_name: "#{plural_klass_name}_controller".capitalize.camelize,
+        handler: "controller.#{klass_name}.router",
+        Layers: [{ Ref: "SvrlessLayer" }],
+        runtime: "ruby2.7"
+      }
+    end
+
+    def events_hash
+      hash = {}
+      @actions.each do |action|
+        hash.merge! EventGenerator.new(klass: @klass, action: action).hash_representation
+      end
+      hash
+    end
+
+    def plural_klass_name
+      @klass.to_s.pluralize.underscore
+    end
+
+    def klass_name
+      @klass.to_s.camelize.pluralize
+    end
+  end
+end

data/lib/svrless/generators/cloud_formation/layer_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "svrless"
+
+module CloudFormation
+  # Generates a hash representation of a AWS::Serverless::LayerVersion
+  class LayerGenerator
+    # TODO: allow naming overrides via initialize
+
+    def hash_representation
+      {
+        svrless_layer: {
+          type: "AWS::Serverless::LayerVersion",
+          properties: hash_properties
+        }
+      }
+    end
+
+    private
+
+    def hash_properties
+      {
+        layer_name: "svrless-shared-layer",
+        description: "SVRLESS shared logic",
+        content_uri: "app/shared/.",
+        compatible_runtimes: ["ruby2.7"]
+      }
+    end
+  end
+end

data/lib/svrless/generators/cloud_formation/main_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "svrless"
+require_relative "layer_generator"
+require_relative "function_generator"
+
+module CloudFormation
+  # The main outer shell of SAM template generators
+  class MainGenerator
+    AWS_TEMPLATE_VERSION = "2010-09-09"
+    AWS_TRANSFORM_VERSION = "AWS::Serverless-2016-10-31"
+
+    attr_accessor :klasses, :actions
+
+    def initialize(klasses:, actions:)
+      @klasses = klasses
+      @actions = actions
+    end
+
+    def representation
+      main_template_hash.deep_transform_keys { |k| k.to_s.capitalize.camelize }.to_yaml
+    end
+
+    def hash_representation
+      main_template_hash
+    end
+
+    private
+
+    def main_template_hash
+      {
+        a_w_s_template_format_version: AWS_TEMPLATE_VERSION,
+        transform: AWS_TRANSFORM_VERSION,
+        resources: resources_hash
+      }
+    end
+
+    def resources_hash
+      resources = {}
+      resources.merge! function_hashes
+      resources.merge! CloudFormation::LayerGenerator.new.hash_representation
+      resources
+    end
+
+    def function_hashes
+      functions = {}
+      @klasses.each do |klass|
+        functions.merge! CloudFormation::FunctionGenerator.new(klass: klass, actions: actions).hash_representation
+      end
+      functions
+    end
+  end
+end

data/lib/svrless/resource_generator.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "svrless"
+
+module ResourceGenerator
+  module ClassMethods
+    DEFAULT_ACTIONS = %i[create show update destroy].freeze
+
+    def resources(*args)
+      generate_svrless_controller
+      generate_cloudformation(klasses: args, actions: DEFAULT_ACTIONS)
+      generate_function_files(klasses: args, actions: DEFAULT_ACTIONS)
+    end
+
+    def generate_cloudformation(klasses:, actions:)
+      output = File.open("template.yaml", "w")
+      output << CloudFormation::MainGenerator.new(klasses: klasses, actions: actions).representation
+      output.close
+    end
+
+    def plural_klass_name(klass)
+      klass.to_s.pluralize
+    end
+
+    def full_klass_name(klass)
+      klass.to_s.camelize.pluralize
+    end
+
+    def generate_function_files(klasses:, actions:)
+      klasses.each do |klass|
+        generate_function_file(klass: klass, actions: actions)
+      end
+    end
+
+    def generate_function_file(klass:, actions:)
+      Dir.mkdir("app") unless Dir.exist?("app")
+      Dir.mkdir("app/functions") unless Dir.exist?("app/functions")
+      unless Dir.exist?("app/functions/#{plural_klass_name(klass)}")
+        Dir.mkdir("app/functions/#{plural_klass_name(klass)}")
+      end
+      FileUtils.touch("app/functions/#{plural_klass_name(klass)}/controller.rb")
+      File.open("app/functions/#{plural_klass_name(klass)}/controller.rb", "w") do |f|
+        f.write "require 'svrless_controller'"
+        f.write "\n"
+        f.write "\n"
+        f.write "class #{full_klass_name(klass)} < SvrlessController"
+        f.write "\n"
+        actions.each_with_index do |method, index|
+          f.write "  def self.#{method}(event:, context:)\n"
+          f.write "    {\n"
+          f.write "      statusCode: 200,\n"
+          f.write "      body: { hello: 'world' }.to_json\n"
+          f.write "    }\n"
+          f.write "  end\n"
+          f.write "\n" unless actions.size == index + 1
+        end
+        f.write  "end"
+        f.write  "\n"
+      end
+    end
+
+    def generate_svrless_controller
+      Dir.mkdir("app") unless Dir.exist?("app")
+      Dir.mkdir("app/shared") unless Dir.exist?("app/shared")
+      Dir.mkdir("app/shared/ruby") unless Dir.exist?("app/shared/ruby")
+      Dir.mkdir("app/shared/ruby/lib") unless Dir.exist?("app/shared/ruby/lib")
+      File.open("app/shared/ruby/lib/svrless_controller.rb", "w") do |f|
+        f.write "class SvrlessController\n"
+        f.write "  def self.router(event:, context:)\n"
+        f.write "    case event['httpMethod']\n"
+        f.write "    when 'GET'\n"
+        f.write "      show(event: event, context: context)\n"
+        f.write "    when 'POST'\n"
+        f.write "      create(event: event, context: context)\n"
+        f.write "    when 'DELETE'\n"
+        f.write "      destroy(event: event, context: context)\n"
+        f.write "    else\n"
+        f.write "      update(event: event, context: context)\n"
+        f.write "    end\n"
+        f.write "  end\n"
+        f.write "end\n"
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+end

data/lib/svrless/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Svrless
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svrless
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - zrthko
@@ -45,7 +45,11 @@ files:
 - bin/setup
 - bin/svrless
 - lib/svrless.rb
-- lib/svrless/event.rb
+- lib/svrless/generators/cloud_formation/event_generator.rb
+- lib/svrless/generators/cloud_formation/function_generator.rb
+- lib/svrless/generators/cloud_formation/layer_generator.rb
+- lib/svrless/generators/cloud_formation/main_generator.rb
+- lib/svrless/resource_generator.rb
 - lib/svrless/version.rb
 - svrless.gemspec
 homepage: https://github.com/svrless/svrless

data/lib/svrless/event.rb

@@ -1,179 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/all"
-require "yaml"
-
-module Event
-  module ClassMethods
-    def events(*args, resource)
-      raise StandardError, "Event: You need to supply at least one argument" if args.empty?
-
-      events = args
-      generate(events, resource)
-    end
-
-    def resource(args)
-      resource = args
-      events(:create, :show, :update, :destroy, resource)
-      generate_function_files(:create, :show, :update, :destroy, resource)
-      generate_svrless_controller
-    end
-
-    def generate(events, resource)
-      puts "Generating resource..."
-      # make_function_files
-      output = File.open("template.yaml", "w")
-      output << main_representation(events, resource)
-      output.close
-      puts "DONE!"
-    end
-
-    def main_representation(events, resource)
-      {
-        a_w_s_template_format_version: "2010-09-09",
-        transform: "AWS::Serverless-2016-10-31",
-        resources: resources_hash(events, resource)
-      }.deep_transform_keys { |k| k.to_s.capitalize.camelize }.to_yaml
-    end
-
-    def resources_hash(events, resource)
-      layer.merge(function_hash(events, resource))
-    end
-
-    def layer
-      {
-        svrless_layer: {
-          type: "AWS::Serverless::LayerVersion",
-          properties: {
-            layer_name: "svrless-layer",
-            description: "All the business logic should go in here",
-            content_uri: "app/shared/.",
-            compatible_runtimes: ["ruby2.7"]
-          }
-        }
-      }
-    end
-
-    def function_hash(events, resource)
-      {
-        "#{plural_classname(resource)}_controller": {
-          type: "AWS::Serverless::Function",
-          properties: {
-            code_uri: "app/functions/#{plural_classname(resource)}",
-            events: hash_of_events(events, resource),
-            function_name: "#{plural_classname(resource)}_controller".capitalize.camelize,
-            handler: "controller.#{full_classname(resource)}.router",
-            Layers: [{ Ref: "SvrlessLayer" }],
-            runtime: "ruby2.7"
-          }
-        }
-      }
-    end
-
-    def hash_of_events(events, resource)
-      h = {}
-      events.each do |event|
-        h.merge!(
-          {
-            "#{event}": {
-              type: "Api",
-              properties: {
-                method: method_from_event(event: event),
-                path: path_from_event(event: event, resource: resource)
-              }
-            }
-          }
-        )
-      end
-      h
-    end
-
-    def plural_classname(resource)
-      resource.to_s.pluralize
-    end
-
-    def method_from_event(event:)
-      case event
-      when :create
-        "post"
-      when :show
-        "get"
-      when :update
-        "put"
-      when :destroy
-        "delete"
-      end
-    end
-
-    def path_from_event(event:, resource:)
-      case event
-      when :create
-        "/#{plural_classname(resource)}"
-      when :show
-        "/#{plural_classname(resource)}/{id}"
-      when :update
-        "/#{plural_classname(resource)}/{id}"
-      when :destroy
-        "/#{plural_classname(resource)}/{id}"
-      end
-    end
-
-    def full_classname(resource)
-      "#{plural_classname(resource)}_controller".camelize
-    end
-
-    def generate_function_files(*args, resource)
-      Dir.mkdir("app") unless Dir.exist?("app")
-      Dir.mkdir("app/functions") unless Dir.exist?("app/functions")
-      unless Dir.exist?("app/functions/#{plural_classname(resource)}")
-        Dir.mkdir("app/functions/#{plural_classname(resource)}")
-      end
-      FileUtils.touch("app/functions/#{plural_classname(resource)}/controller.rb")
-      File.open("app/functions/#{plural_classname(resource)}/controller.rb", "w") do |f|
-        f.write "require 'svrless_controller'"
-        f.write "\n"
-        f.write "\n"
-        f.write "class #{full_classname(resource)} < SvrlessController"
-        f.write "\n"
-        args.each_with_index do |method, index|
-          f.write "  def self.#{method}(event:, context:)\n"
-          f.write "    {\n"
-          f.write "      statusCode: 200,\n"
-          f.write "      body: { hello: 'world' }.to_json\n"
-          f.write "    }\n"
-          f.write "  end\n"
-          f.write "\n" unless args.size == index + 1
-        end
-        f.write  "end"
-        f.write  "\n"
-      end
-    end
-
-    def generate_svrless_controller
-      Dir.mkdir("app") unless Dir.exist?("app")
-      Dir.mkdir("app/shared") unless Dir.exist?("app/shared")
-      Dir.mkdir("app/shared/ruby") unless Dir.exist?("app/shared/ruby")
-      Dir.mkdir("app/shared/ruby/lib") unless Dir.exist?("app/shared/ruby/lib")
-      File.open("app/shared/ruby/lib/svrless_controller.rb", "w") do |f|
-        f.write "class SvrlessController\n"
-        f.write "  def self.router(event:, context:)\n"
-        f.write "    case event['httpMethod']\n"
-        f.write "    when 'GET'\n"
-        f.write "      show(event: event, context: context)\n"
-        f.write "    when 'POST'\n"
-        f.write "      create(event: event, context: context)\n"
-        f.write "    when 'DELETE'\n"
-        f.write "      destroy(event: event, context: context)\n"
-        f.write "    else\n"
-        f.write "      update(event: event, context: context)\n"
-        f.write "    end\n"
-        f.write "  end\n"
-        f.write "end\n"
-      end
-    end
-  end
-
-  def self.included(klass)
-    klass.extend ClassMethods
-  end
-end