ctlst 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258ae040f12a07e26c9c578abbca2c1dd6787661ec643dfc56edb9301235e8ed
-  data.tar.gz: 7396f08f07cbf9e6898def88b1648acbeebdd95b39788dec6ccd46f56e9af20a
+  metadata.gz: 7700cd2537587c97c48f218a566bdd92a949c516960f6d8c0c87177d0a4b19dc
+  data.tar.gz: 0cc0c1bb8627e97bda2ea53b3f1a98758683b077615fc5b5fd430825bd973e4f
 SHA512:
-  metadata.gz: ecb74669054cc38db7479dfb18ccd89bfbbe272a7fcf8b9ee42fd370626929d63dfc47c6fcc824387d0ba74c5509839d8e9f2fdb2e52d8130748a8dd29b7b2ce
-  data.tar.gz: 3679735da58fcf7968e3246d40f7caea1aa469ad12913572a5a05564ae105cd796cd14decc907fb3b8780a20eec4245d1be8a6822ff7449fc63e640f7ed060ef
+  metadata.gz: 89902a121d8d1349750c282c5d6aad533ee4a263a1c613e68ce1525fa2005b88dd38e8123e8c7e52b08efef9958aaa8b9603dc5c1fdcadc96181e1c1158c49ad
+  data.tar.gz: 7439c96f0e09d2d81311d97cf92d1985646cdd396720d0252be0cf06280ac45043ae02f1e5fb314b6c10c8215a71724a7c8b5d870a011e3118905d62a1bc54f3

data/README.md

@@ -1,6 +1,9 @@
 # Ctlst
 Ctlst (pronounced 'Catalyst') is a tool similar to the Rails CLI. It provides simple commands to build React project that takes advantage of clean architecture, test driven development and containerisation. This folder must be added to your PATH.  
 
+### Installation
+`gem install ctlst`
+
 ### Examples
 `ctlst new my_react_app`  
 `ctlst domain ApiKey`  
@@ -9,6 +12,7 @@ Ctlst (pronounced 'Catalyst') is a tool similar to the Rails CLI. It provides si
 `ctlst component AccessStatus`
 
 ### Dependencies
+ - Ruby
  - NPM
  - Docker
  - Docker-compose

data/templates/component/index.js.erb

@@ -1,6 +1,6 @@
 import React from 'react';
 export default class <%= @component_class_name %> extends React.Component {
   render() {
-    return null;
+    
   }
 };

data/templates/component/index.test.js.erb

@@ -2,6 +2,8 @@ import React from "react";
 import <%= @component_class_name %> from ".";
 import { mount } from "enzyme";
 
-describe(<%= @component_class_name %>, () => {
+describe("<%= @component_class_name %>", () => {
+  it("tests functionality", async () => {
 
+  });
 });

data/templates/component.rb

@@ -2,7 +2,7 @@ require_relative '../lib/templates'
 
 module Template
   def self.short_help
-    'component'
+    'component [name] - Creates a component in src/Component (with tests & stories)'
   end
 
   def self.main(*args)

data/templates/domain/index.test.js.erb

@@ -1,5 +1,7 @@
 import <%= @domain_class_name %> from ".";
 
-describe(<%= @domain_class_name %>, () => {
+describe("<%= @domain_class_name %>", () => {
+  it("tests functionality", async () => {
 
+  });
 });

data/templates/domain.rb

@@ -2,7 +2,7 @@ require_relative '../lib/templates'
 
 module Template
   def self.short_help
-    'domain'
+    'domain [name] - Creates a domain in src/Domain (with tests)'
   end
 
   def self.main(*args)

data/templates/gateway/index.test.js.erb

@@ -1,5 +1,7 @@
 import <%= @gateway_class_name %> from ".";
 
-describe(<%= @gateway_class_name %>, () => {
+describe("<%= @gateway_class_name %>", () => {
+  it("tests functionality", async () => {
 
+  });
 });

data/templates/gateway.rb

@@ -2,7 +2,7 @@ require_relative '../lib/templates'
 
 module Template
   def self.short_help
-    'gateway'
+    'gateway [name] - Creates a gateway in src/Gateway (with tests)'
   end
 
   def self.main(*args)

data/templates/help.rb

@@ -1,16 +1,16 @@
 require_relative '../lib/templates'
 module Template
   def self.short_help
-    'help'
+    'help - Displays this help message'
   end
 
   def self.main(*_args)
-    print "Help:\n"
-    print "\t" + short_help + "\n"
+    print "Usage: ctlst <command> [<arguments>]\n"
+    print '  ' + short_help + "\n"
 
     Dir.glob(__dir__ + '/*').select { |f| File.file?(f) && f != __FILE__ }.each do |template|
       require_relative template
-      print "\t" + Template.short_help + "\n"
+      print '  ' + Template.short_help + "\n"
     end
   end
 end

data/templates/new/Makefile.erb

@@ -1,15 +1,22 @@
+.PHONY: serve
 serve: docker-up
 
+.PHONY: docker-up
 docker-up: docker-down docker-build
 	docker-compose up --build
 
+.PHONY: docker-down
 docker-down:
 	docker-compose down
 
+.PHONY: docker-build
 docker-build:
 	docker-compose build
 
-setup: docker-build
-
+.PHONY: shell
 shell:
 	docker exec -ti <%= @project_name %>-app bash
+
+.PHONY: test
+test: docker-down docker-build
+	docker-compose run --rm <%= @project_name %>-app npm test

data/templates/new.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/templates'
 module Template
   def self.short_help
-    'new'
+    'new [name] - Create a new React.js app with a full development environment'
   end
 
   def self.main(*args)

data/templates/usecase/index.js.erb

@@ -1,3 +1,9 @@
 export default class <%= @component_class_name %> extends React.Component {
+  constructor() {
 
+  }
+
+  async execute() {
+    
+  }
 };

data/templates/usecase/index.test.js.erb

@@ -1,5 +1,7 @@
 import <%= @usecase_class_name %> from ".";
 
-describe(<%= @usecase_class_name %>, () => {
+describe("<%= @usecase_class_name %>", () => {
+  it("tests functionality", async () => {
 
+  });
 });

data/templates/usecase.rb

@@ -2,7 +2,7 @@ require_relative '../lib/templates'
 
 module Template
   def self.short_help
-    'usecase'
+    'usecase [name] - Creates a usecase in src/Usecase (with tests)'
   end
 
   def self.main(*args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ctlst
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Faissal Bensefia