command_class 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db12173fa0f453ff13d6ca3d6e02ac6a00c51b15aaa307902c4c8fb0a1915a55
-  data.tar.gz: 43265b25a5f2ecd473eacbcfc680b4f5ec52037dade4cb7297236e9fefe51c18
+  metadata.gz: 5d7721d152aaadf54c4b668e790c389f11c8f76e592c405954422041718b2a56
+  data.tar.gz: 416070df89717db87c2768d66f15bece693158f8987261fe3a163f469e92ca05
 SHA512:
-  metadata.gz: 1af10ca2ecf0be56fe7dd74e8cc5c99545a92bbeb8b478e4121fc93975366096ad546744a2493c34169341daf5c59c519d8faf9d7ddc0474c50f107b1a087a21
-  data.tar.gz: 375eb3cedd42259268a433fa0c9ec8bd0e1d91c5e87a962ea5a5146b7ad47262a7309fc64b52227b3f96250904431a7f451da687bebc395d6fa9ebbae0c5d3ce
+  metadata.gz: f392b0b33006919cf2551c84485cdb4e5d5bfa9255a96b1eef609aac3a297e83716ddae4a5216bc6252d9fdb968d3b510022ba02044c8799a49b4f518bccc474
+  data.tar.gz: fccc0ee2ba3118e18a30c239c372f445901cfe2f10be76314ffb0fe10174165fba5f54164f794b96813ddd7ac0f6b50e7f835c38d5005ff811f4b28b74af711e

data/lib/command_class.rb

@@ -1,6 +1,18 @@
 class CommandClass
+
+  module Include
+    def command_class(dependencies:, inputs:, &blk)
+      CommandClass.commandify(self, dependencies, inputs, &blk)
+    end
+  end
+
   def self.new(dependencies:, inputs:, &blk)
-    cmd_cls = Class.new
+    commandify(Class.new, dependencies, inputs, &blk)
+  end
+
+  # Turns the class into a command class
+  #
+  def self.commandify(cmd_cls, dependencies, inputs, &blk)
     cmd_cls.const_set('DEFAULT_DEPS', dependencies)
 
     cmd_cls.class_eval <<~RUBY
@@ -29,6 +41,7 @@ class CommandClass
 
     private
 
+
     # TODO: allow for unnamed as well
     def cmd_call_signature(inputs)
       inputs.map {|x| "#{x}:" }.join(', ')

data/spec/command_class_spec.rb

@@ -1,73 +1,12 @@
 require 'rspec'
-require_relative"../lib/command_class"
+require_relative '../lib/command_class'
+require_relative './create_user'
 
-# 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
+  # NOTE: See create_user.rb for example usage.
+  #
+  context "CreateUser with ::Include syntax and custom errors" do
     let(:email_svc) { spy('email') }
     let(:user_repo) { spy('user_repo') }
     let(:valid_name) { 'John' }
@@ -105,13 +44,13 @@ describe CommandClass do
       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.to raise_error(CreateUser::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.to raise_error(CreateUser::InvalidEmail)
       end
     end
 
@@ -129,7 +68,7 @@ describe CommandClass do
       it 'errors' do
         expect do
           create_user.(name: valid_name, email: valid_email, password: valid_pw)
-        end.to raise_error(Errors::EmailAlreadyExists)
+        end.to raise_error(CreateUser::EmailAlreadyExists)
       end
     end
   end

data/spec/old_command_class_spec.rb

@@ -0,0 +1,74 @@
+require 'rspec'
+require_relative '../lib/command_class'
+require_relative './create_user2'
+
+describe CommandClass do
+
+  context "Full CreateUser2 example using legacy syntax" 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
+        CreateUser2.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
+        CreateUser2.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
+        CreateUser2.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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_class
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonah Goldstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2019-03-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - lib/command_class.rb
 - spec/command_class_spec.rb
+- spec/old_command_class_spec.rb
 homepage: https://github.com/jonahx/command_class
 licenses:
 - MIT
@@ -44,3 +45,4 @@ specification_version: 4
 summary: Create functional command objects without boilerplate
 test_files:
 - spec/command_class_spec.rb
+- spec/old_command_class_spec.rb