command_class 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db12173fa0f453ff13d6ca3d6e02ac6a00c51b15aaa307902c4c8fb0a1915a55
+  data.tar.gz: 43265b25a5f2ecd473eacbcfc680b4f5ec52037dade4cb7297236e9fefe51c18
+SHA512:
+  metadata.gz: 1af10ca2ecf0be56fe7dd74e8cc5c99545a92bbeb8b478e4121fc93975366096ad546744a2493c34169341daf5c59c519d8faf9d7ddc0474c50f107b1a087a21
+  data.tar.gz: 375eb3cedd42259268a433fa0c9ec8bd0e1d91c5e87a962ea5a5146b7ad47262a7309fc64b52227b3f96250904431a7f451da687bebc395d6fa9ebbae0c5d3ce

data/lib/command_class.rb

@@ -0,0 +1,53 @@
+class CommandClass
+  def self.new(dependencies:, inputs:, &blk)
+    cmd_cls = Class.new
+    cmd_cls.const_set('DEFAULT_DEPS', dependencies)
+
+    cmd_cls.class_eval <<~RUBY
+      def initialize(**passed_deps)
+        deps = DEFAULT_DEPS.merge(passed_deps)
+        deps.each { |name, val| instance_variable_set('@' + name.to_s, val) }
+      end
+
+      def call(#{cmd_call_signature(inputs)})
+        Call.new(#{call_ctor_args(dependencies, inputs)}).()
+      end
+    RUBY
+
+    call_class = Class.new(cmd_cls, &blk)
+    call_class.class_eval <<~RUBY
+      def initialize(#{call_ctor_sig(dependencies, inputs)})
+        #{set_input_attrs(dependencies, inputs)}
+      end
+    RUBY
+
+    cmd_cls.const_set('Call', call_class)
+    cmd_cls
+  end
+
+  class << self
+
+    private
+
+    # TODO: allow for unnamed as well
+    def cmd_call_signature(inputs)
+      inputs.map {|x| "#{x}:" }.join(', ')
+    end
+
+    def set_input_attrs(deps, inputs)
+      all_args(deps, inputs).map {|x| "@#{x} = #{x}" }.join('; ')
+    end
+
+    def call_ctor_sig(deps, inputs)
+      all_args(deps, inputs).join(', ')
+    end
+
+    def call_ctor_args(deps, inputs)
+      [deps.keys.map { |x| "@#{x}" } + inputs].join(', ')
+    end
+
+    def all_args(deps, inputs)
+      deps.keys + inputs
+    end
+  end
+end

data/spec/command_class_spec.rb

@@ -0,0 +1,137 @@
+require 'rspec'
+require_relative"../lib/command_class"
+
+# Setup classes and collaborators to test
+#
+UserRepo = Class.new
+MyEmailService = Class.new
+
+module Errors
+  class InvalidName < RuntimeError; end
+  class InvalidEmail < RuntimeError; end
+  class InvalidPassword < RuntimeError; end
+  class EmailAlreadyExists < RuntimeError; end
+end
+
+CreateUser = CommandClass.new(
+  dependencies: {user_repo: UserRepo, email_service: MyEmailService},
+  inputs: [:name, :email, :password]
+) do
+
+  def call
+    validate_input
+    ensure_unique_email
+    insert_user
+    send_confirmation
+  end
+
+  private
+
+  def validate_input
+    validate_name
+    validate_email
+    validate_password
+  end
+
+  def ensure_unique_email
+    email_exists = @user_repo.find_by_email(@email)
+    raise Errors::EmailAlreadyExists if email_exists
+  end
+
+  def insert_user
+    @user_repo.insert(name: @name, email: @email, password: @password)
+  end
+
+  def send_confirmation
+    @email_service.send_signup_confirmation(name: @name, email: @email)
+  end
+
+  def validate_name
+    valid = @name.size > 1
+    raise Errors::InvalidName unless valid
+  end
+
+  def validate_email
+    valid = @email =~ /@/
+    raise Errors::InvalidEmail unless valid
+  end
+
+  def validate_password
+    valid = @password.size > 5
+    raise Errors::InvalidPassword unless valid
+  end
+
+end
+
+# THE TESTS THEMSELVES
+#
+describe CommandClass do
+
+  context "full CreateUser example" do
+    let(:email_svc) { spy('email') }
+    let(:user_repo) { spy('user_repo') }
+    let(:valid_name) { 'John' }
+    let(:valid_email) { 'john@gmail.com' }
+    let(:valid_pw) { 'secret' }
+
+    describe "happy path" do
+      let(:happy_repo) do
+        user_repo.tap do |x|
+          allow(x).to receive(:find_by_email).and_return(nil)
+        end
+      end 
+
+      subject(:create_user) do
+        CreateUser.new(user_repo: happy_repo, email_service: email_svc)
+      end
+
+      it 'inserts the user into the db' do
+        create_user.(name: valid_name, email: valid_email, password: valid_pw)
+        expect(user_repo).to have_received(:insert)
+      end
+
+      it 'sends the confirmation email' do
+        create_user.(name: valid_name, email: valid_email, password: valid_pw)
+        expect(email_svc).to have_received(:send_signup_confirmation)
+      end
+
+    end
+
+    describe "invalid user input" do
+      subject(:create_user) do
+        CreateUser.new(user_repo: user_repo, email_service: email_svc)
+      end
+
+      it 'errors for a short name' do
+        expect do
+          create_user.(name: 'x', email: valid_email, password: valid_pw)
+        end.to raise_error(Errors::InvalidName)
+      end
+
+      it 'errors on an invalid email' do
+        expect do
+          create_user.(name: valid_email, email: 'bad_email', password: valid_pw)
+        end.to raise_error(Errors::InvalidEmail)
+      end
+    end
+
+    describe "existing email" do
+      let(:repo_with_email) do
+        user_repo.tap do |x|
+          allow(x).to receive(:find_by_email).and_return('user obj')
+        end
+      end 
+
+      subject(:create_user) do
+        CreateUser.new(user_repo: repo_with_email, email_service: email_svc)
+      end
+
+      it 'errors' do
+        expect do
+          create_user.(name: valid_name, email: valid_email, password: valid_pw)
+        end.to raise_error(Errors::EmailAlreadyExists)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: command_class
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonah Goldstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-19 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/command_class.rb
+- spec/command_class_spec.rb
+homepage: https://github.com/jonahx/command_class
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Create functional command objects without boilerplate
+test_files:
+- spec/command_class_spec.rb