frap 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef6521f457477ddc6134a27414d21d4b4b5f9b2925e5557c93ebd6f1f6fd03e6
-  data.tar.gz: 68cfd88891882c2af7de923fb8d7edf170570ef0df2be6b21f027def7758fe77
+  metadata.gz: 9c9b0b37bc3db97c0fa4da096081a9172a2a4579eb185ea1b3a3613e2eec9e53
+  data.tar.gz: 5c701bc7b28b449fa300f4c3449d07bda9b530983ae2d67637cb3b1891feb8d9
 SHA512:
-  metadata.gz: 0fd9d56712b5eed4920c96fbc42e0253ee5ecfdeb161fee387d9bffe5b5aa9c2625acb6a27d6de22dd0526095b34f2e6262f2b3c2543de76e2e8f06af6140c59
-  data.tar.gz: 53d94d94a6049fe3374d8a4170b17ac7fd5b512e27ea37ef640becbcb36c0d87d1cf4022493050f41e9a0cb297dd090fa944f4e8ac828e2f322c6c414b1d878f
+  metadata.gz: 99fcc47f280d953775d23f796ebc76c19196b2c21bdf183860854310f5ff188056e53599bdd4f6c4c239592ebcb5db9a24227c3d7c5500f79adc7b19205beb02
+  data.tar.gz: 1407e786731d16af8f5b8d9b2ebb3f9dfcbd182e1b29cfacc4e0d856b2189f766c9433e51b52dac2786dfd9ab067f7aaa02225ad3636f9c5dfdc34023e86321e

data/.gitignore

@@ -12,4 +12,7 @@
 
 # IDEs
 .idea
-*.gem
+
+*.gem
+/test_app/**/*
+

data/Gemfile.lock

@@ -1,12 +1,59 @@
 PATH
   remote: .
   specs:
-    frap (0.0.3)
+    frap (0.1.1)
+      thor (~> 0.20.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -21,6 +68,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
@@ -28,6 +79,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0.2)
   frap!
+  railties (~> 5.2.3)
   rake (~> 10.0)
   rspec (~> 3.7.0)
 

data/README.md

@@ -1,14 +1,15 @@
 [![Build Status](https://travis-ci.com/flippakitten/frap.svg?branch=master)](https://travis-ci.com/flippakitten/frap)
+[![Gem Version](https://badge.fury.io/rb/frap.svg)](https://badge.fury.io/rb/frap) [![Join the chat at https://gitter.im/frap-flutter-rails-cli/community](https://badges.gitter.im/frap-flutter-rails-cli/community.svg)](https://gitter.im/frap-flutter-rails-cli/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 # Frap 
-CLI interface to quickly prototype Flutter App's using the BLoC pattern with a Rails API server. 
-**Note:** This is the absolute beginning of the app. **Version 0.1.0 will have the basic app creation**
+CLI interface to quickly prototype Flutter App's using the BLoC pattern with a Rails API server.  
+
+[changelog](https://github.com/flippakitten/frap/wiki/Change-Log-Published)  
+[roadmap](https://github.com/flippakitten/frap/projects/1)  
 
 ## Prerequisites
-While building the CLI, we will be using [slidy](https://pub.dev/packages/slidy) CLI. This will mean initially there will be some limitations, there is a plan to remove the dependancy in later versions.  
 
 Ensure the following are installed:
 * [Flutter](https://flutter.dev/docs/get-started/install)
-* [Slidy](https://pub.dev/packages/slidy#instalation)
 * [Ruby 2.6.1](https://rvm.io/rvm/install) (I've used RVM but you can install it anyway)
 * Rails
 

data/bin/frap

@@ -2,43 +2,4 @@
 require 'frap'
 require 'optparse'
 
-options = {}
-
-opt_parser = OptionParser.new do |opt|
-  opt.banner = "Usage: frap COMMAND [OPTIONS]"
-  opt.separator  ""
-  opt.separator  "Commands"
-  opt.separator  "     new: create a new Flutter and Rails app (requires app name as second argument"
-  opt.separator  "     generate: generates a template"
-  opt.separator  ""
-  opt.separator  "Options"
-
-  opt.on("-f","--fields FIELDS","comman separated list of fields with types") do |fields|
-    options[:fields] = fields
-  end
-
-  opt.on("-h","--help","help") do
-    puts opt_parser
-  end
-end
-
-opt_parser.parse!
-
-case ARGV[0]
-when "new"
-  unless ARGV[1]
-    puts "ERROR: Please specify an app path `frap new APP_PATH`"
-    return
-  end
-
-  Frap::CreateApp.new(ARGV[1]).build
-when 'g'
-when "generate"
-  unless ARGV[1]
-    puts "ERROR: Please specify a generator function `frap g resource MyResource -f name:string`"
-    return
-  end
-  puts "generate #{ARGV[1]} #{options[:fields]}"
-else
-  puts opt_parser
-end
+Frap::CLI.start(ARGV)

data/frap.gemspec

@@ -25,14 +25,16 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
   end
   spec.bindir        = "bin"
   spec.executables   = ['frap']
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>= 2.6.1'
+  spec.add_dependency 'thor', '~> 0.20.3'
 
   spec.add_development_dependency "bundler", "~> 2.0.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.7.0"
+  spec.add_development_dependency "railties", "~> 5.2.3"
 end

data/lib/frap.rb

@@ -1,5 +1,35 @@
 require 'frap/version'
 require 'frap/create_app'
+require 'frap/generators/generate'
+require 'frap/generators/config'
+require 'frap/generators/flutter_config'
+require 'thor'
+require 'yaml'
 
 module Frap
+  class CLI < Thor
+    desc 'version', 'Display MyGem version'
+    map %w[-v --version] => :version
+    class_option 'verbose', type: :boolean, default: false
+
+    def version
+      say "Frap #{Frap::VERSION}"
+    end
+
+    desc 'new APP_NAME', 'Lower cased underscored app name'
+    long_desc <<-LONGDESC
+      Using the "app_name", it will create the parent directory and the Rails and Flutter sub directories, 
+      "app_name_server" and "app_name_ui"
+    LONGDESC
+    def new(app_name)
+      CreateApp.new(app_name).build
+    end
+
+    desc 'generate GENERATOR RESOURCE_NAME', 'Specify the generator and a name'
+    long_desc <<-LONGDESC
+      Generate all the boiler plate code such as controllers, pages and blocks for Rails and Flutter.
+      run `frap g help` to see a list of existing generators
+    LONGDESC
+    subcommand 'generate', Frap::Generators::Generate
+  end
 end

data/lib/frap/create_app.rb

@@ -1,3 +1,6 @@
+require 'thor'
+require 'frap/generators/config'
+
 module Frap
   class CreateApp
     attr_accessor :name
@@ -7,44 +10,82 @@ module Frap
     end
 
     def build
-      create_parent_app
+      setup_parent_directory
       create_rails_api_server
       create_flutter_app
-      setup_bloc_patter
+      setup_bloc_pattern
       show_completed_notes
     end
 
     private
 
-    def create_parent_app
-      puts "1 ================ Create Parent Directory #{name}"
+    def setup_parent_directory
+      shell.say(shell_text("Create Parent Directory #{name}"), :green)
+
+      Frap::Generators::Config.new(
+        [name],
+        options: {
+          destination_root: Dir.pwd
+        }
+      ).invoke(:configure_directories)
 
-      system("mkdir #{name}")
-      Dir.chdir(name)
+      Dir.chdir(working_dir)
     end
 
     def create_rails_api_server
-      puts "2 ================ Rails new #{name}_server --api"
+      shell.say(shell_text("Rails new #{server_name} --api -T"), :green)
 
-      system("rails new #{name}_server --api -T")
+      Kernel.system("rails new #{server_name} --api -T")
     end
 
     def create_flutter_app
-      puts "3 ================ Flutter create app #{name}_ui"
-      system("flutter create #{name}_ui")
+      shell.say(shell_text("Flutter create app #{ui_name}"), :green)
+
+      Kernel.system("flutter create #{ui_name}")
     end
 
-    def setup_bloc_patter
-      puts '4 ================ Setup BLoC pattern using Slidy'
-      Dir.chdir("#{name}_ui")
-      system('rm -rf lib/')
-      system('mkdir lib')
-      system('slidy start')
+    def setup_bloc_pattern
+      shell.say(shell_text('Setup BLoC pattern'), :green)
+
+      Frap::Generators::FlutterConfig.new(
+        [name, ui_name],
+        options: {
+          destination_root: Dir.pwd
+        }
+      ).invoke(:configure_directories)
+
+      Dir.chdir("#{working_dir}/#{ui_name}")
+      Kernel.system('git init && flutter pub get')
+      Dir.chdir(working_dir)
     end
 
     def show_completed_notes
-      puts '================================= '
-      puts 'TODO: Install your favourite Rails Testing library'
+      shell.say(shell_text('DONE'), :green)
+      shell.say('TODO: Install your favourite Rails Testing library', :yellow)
+    end
+
+    def server_name
+      "#{name}_server"
+    end
+
+    def ui_name
+      "#{name}_ui"
+    end
+
+    def working_dir
+      @working_dir ||= "#{Dir.pwd}/#{name}"
+    end
+
+    def shell
+      @shell ||= Thor::Shell::Color.new
+    end
+
+    def shell_text(text)
+      "#{spacer} #{text} #{spacer}"
+    end
+
+    def spacer
+      '================'
     end
   end
 end

data/lib/frap/generators/config.rb

@@ -0,0 +1,30 @@
+require 'thor'
+require 'thor/group'
+
+module Frap
+  module Generators
+    class Config < Thor::Group
+      include Thor::Actions
+
+      desc 'Generate a config file'
+      argument :name
+
+      def self.source_root
+        File.dirname(__FILE__) + '/templates'
+      end
+
+      def configure_directories
+        invoke :create_app_dir
+      end
+
+      def create_app_dir
+        empty_directory(name)
+        invoke :create_config_file
+      end
+
+      def create_config_file
+        template('config.erb', "#{name}/config.yml")
+      end
+    end
+  end
+end

data/lib/frap/generators/flutter_config.rb

@@ -0,0 +1,61 @@
+
+require 'thor'
+require 'thor/group'
+
+module Frap
+  module Generators
+    class FlutterConfig < Thor::Group
+      include Thor::Actions
+
+      desc 'Generate Flutter Config files'
+      argument :name
+      argument :folder_name
+
+      def self.source_root
+        File.dirname(__FILE__) + '/templates/dart'
+      end
+
+      def configure_directories
+        inject_into_file("#{working_directory}/pubspec.yaml", pub_files, after: /^dependencies:.*$/)
+        remove_file("#{lib_directory}/main.dart")
+        invoke :create_directories
+      end
+
+      def create_directories
+        empty_directory("#{lib_directory}/src/home")
+        invoke :create_files
+      end
+
+      def create_files
+        template('main.dart.erb', "#{lib_directory}/main.dart")
+        template('src/app_bloc.dart.erb', "#{src_directory}/app_bloc.dart")
+        template('src/app_module.dart.erb', "#{src_directory}/app_module.dart")
+        template('src/app_widget.dart.erb', "#{src_directory}/app_widget.dart")
+        template('src/home/home_bloc.dart.erb', "#{src_directory}/home/home_bloc.dart")
+        template('src/home/home_module.dart.erb', "#{src_directory}/home/home_module.dart")
+        template('src/home/home_page.dart.erb', "#{src_directory}/home/home_page.dart")
+      end
+
+      private
+
+      def working_directory
+        "#{destination_root}/#{folder_name}"
+      end
+
+      def lib_directory
+        "#{working_directory}/lib"
+      end
+
+      def src_directory
+        "#{lib_directory}/src"
+      end
+
+      def pub_files
+        %Q(
+  dio: ^2.1.13
+  rxdart: ^0.22.0
+  bloc_pattern: ^2.2.3)
+      end
+    end
+  end
+end

data/lib/frap/generators/generate.rb

@@ -0,0 +1,17 @@
+require 'thor'
+require 'frap/generators/resource'
+
+module Frap
+  module Generators
+    class Generate < Thor
+      desc 'resource NAME', 'generate a resource'
+      method_option :rails, type: :boolean, aliases: :r, default: true
+      method_option :flutter, type: :boolean, aliases: :f, default: true
+      method_option :attributes, type: :hash, aliases: :a
+
+      def resource(name)
+        Frap::Generators::Resource.new(name, options).create_resource
+      end
+    end
+  end
+end

data/lib/frap/generators/resource.rb

@@ -0,0 +1,42 @@
+require 'thor'
+
+module Frap
+  module Generators
+    class Resource
+      attr_accessor :name, :attributes, :options
+
+      def initialize(name, options)
+        @name = name
+        @options = options
+      end
+
+      def create_resource
+        generate_rails_resource if options['rails']
+        generate_flutter_resource if options['flutter']
+      end
+
+      private
+
+      def generate_rails_resource
+
+
+        puts "TODO: rails g resource #{fields}"
+      end
+
+      def generate_flutter_resource
+        puts "TODO: frap g flutter resource #{fields}"
+      end
+
+      def fields
+        @fields ||= build_fields
+      end
+
+      def build_fields
+        fields_string = ''
+        options[:attributes].each { |k, v| fields_string << "#{k}:#{v} " }
+
+        return fields_string
+      end
+    end
+  end
+end

data/lib/frap/generators/templates/config.erb

@@ -0,0 +1,3 @@
+app_name: <%= name %>
+rails_app: <%= "#{name}_server" %>
+flutter_app: <%= "#{name}_ui" %>

data/lib/frap/generators/templates/dart/main.dart.erb

@@ -0,0 +1,4 @@
+import 'package:flutter/material.dart';
+import 'package:<%= folder_name %>/src/app_module.dart';
+
+void main() => runApp(AppModule());

data/lib/frap/generators/templates/dart/src/app_bloc.dart.erb

@@ -0,0 +1,9 @@
+import 'package:bloc_pattern/bloc_pattern.dart';
+
+class AppBloc extends BlocBase {
+//dispose will be called automatically by closing its streams
+  @override
+  void dispose() {
+    super.dispose();
+  }
+}

data/lib/frap/generators/templates/dart/src/app_module.dart.erb

@@ -0,0 +1,19 @@
+import 'package:bloc_pattern/bloc_pattern.dart';
+import 'package:flutter/material.dart';
+import 'package:<%= folder_name %>/src/app_widget.dart';
+import 'package:<%= folder_name %>/src/app_bloc.dart';
+
+class AppModule extends ModuleWidget {
+  @override
+  List<Bloc> get blocs => [
+    Bloc((i) => AppBloc()),
+  ];
+
+  @override
+  List<Dependency> get dependencies => [];
+
+  @override
+  Widget get view => AppWidget();
+
+  static Inject get to => Inject<AppModule>.of();
+}

data/lib/frap/generators/templates/dart/src/app_widget.dart.erb

@@ -0,0 +1,15 @@
+import 'package:flutter/material.dart';
+import 'package:<%= folder_name %>/src/home/home_module.dart';
+
+class AppWidget extends StatelessWidget {
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: '<%= name.split(/ |\_|\-/).map(&:capitalize).join(' ') %> App',
+      theme: ThemeData(
+        primarySwatch: Colors.blue,
+      ),
+      home: HomeModule(),
+    );
+  }
+}

data/lib/frap/generators/templates/dart/src/home/home_bloc.dart.erb

@@ -0,0 +1,9 @@
+import 'package:bloc_pattern/bloc_pattern.dart';
+
+class HomeBloc extends BlocBase {
+  //dispose will be called automatically by closing its streams
+  @override
+  void dispose() {
+    super.dispose();
+  }
+}

data/lib/frap/generators/templates/dart/src/home/home_module.dart.erb

@@ -0,0 +1,19 @@
+import 'package:<%= folder_name %>/src/home/home_bloc.dart';
+import 'package:bloc_pattern/bloc_pattern.dart';
+import 'package:flutter/material.dart';
+import 'package:<%= folder_name %>/src/home/home_page.dart';
+
+class HomeModule extends ModuleWidget {
+  @override
+  List<Bloc> get blocs => [
+    Bloc((i) => HomeBloc()),
+  ];
+
+  @override
+  List<Dependency> get dependencies => [];
+
+  @override
+  Widget get view => HomePage();
+
+  static Inject get to => Inject<HomeModule>.of();
+}

data/lib/frap/generators/templates/dart/src/home/home_page.dart.erb

@@ -0,0 +1,20 @@
+import 'package:flutter/material.dart';
+
+class HomePage extends StatefulWidget {
+  @override
+  _HomePageState createState() => _HomePageState();
+}
+
+class _HomePageState extends State<HomePage> {
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: Text("Home"),
+      ),
+      body: Center(
+        child: Text('<%= folder_name %> Home'),
+      ),
+    );
+  }
+}

data/lib/frap/version.rb

@@ -1,3 +1,3 @@
 module Frap
-  VERSION = "0.0.3"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: frap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - James Gascoigne - Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
 description: CLI to create a Flutter App backed with a Rails server for quick app
   protoyping
 email:
@@ -77,6 +105,18 @@ files:
 - frap.gemspec
 - lib/frap.rb
 - lib/frap/create_app.rb
+- lib/frap/generators/config.rb
+- lib/frap/generators/flutter_config.rb
+- lib/frap/generators/generate.rb
+- lib/frap/generators/resource.rb
+- lib/frap/generators/templates/config.erb
+- lib/frap/generators/templates/dart/main.dart.erb
+- lib/frap/generators/templates/dart/src/app_bloc.dart.erb
+- lib/frap/generators/templates/dart/src/app_module.dart.erb
+- lib/frap/generators/templates/dart/src/app_widget.dart.erb
+- lib/frap/generators/templates/dart/src/home/home_bloc.dart.erb
+- lib/frap/generators/templates/dart/src/home/home_module.dart.erb
+- lib/frap/generators/templates/dart/src/home/home_page.dart.erb
 - lib/frap/version.rb
 homepage: https://github.com/flippakitten/frap
 licenses: