swift-gist 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34a4f21d64d9a746405bab46332c7c2f3b76d28b
-  data.tar.gz: 07f090ec0a08b41ab1b51e812a3ea838b68596a8
+  metadata.gz: 07dc7f889af55eb6a518f8bf00e6f86bb83d5702
+  data.tar.gz: fcd36b11560ffd97fe8365e7397c2b8ea9a331c9
 SHA512:
-  metadata.gz: 21f4194bbaf569276efbc421842b79128f0fb27e633de1915342eac1c75cf3dc3c403f535b132850116aba08cbea8ed4ef98c22981411c2700cdd2123b3731af
-  data.tar.gz: c564a8882bfde54a51797d4ea41bafa6971634f43b13f457eab249c35c2cbb9274b242078381d86ea5d0239ba7f8c5284653e8c58a4eaa3d759aace1a2a8cdb6
+  metadata.gz: 0312a7227f6f66da89ec6223f221b4eb0dfe8d575ecdc3f731669eac79b67e0ab71413c81fa03fb475e54de9db974f8dfc3c0f0d3cb2e39c7824e17f542b29af
+  data.tar.gz: 622b8e3935c07d9ca07e0d93ac06ba23bba5e935ae9f9366ca63f77955981a7280f6b58c7b3526b36bb4c6974414084d68c4bd39643f047f1544994b8daad52e

data/Gemfile.lock

@@ -1,15 +1,25 @@
 PATH
   remote: .
   specs:
-    swift-gist (0.0.1)
+    swift-gist (0.0.2)
+      listen (~> 3.1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.3.0)
+    ffi (1.9.23)
     json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
     minitest (5.11.3)
     rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    ruby_dep (1.5.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)

data/README.md

@@ -1 +1,79 @@
-...
+# swift-gist
+
+A tool to reduce feedback cycles when doing TDD with Swift.
+
+TDD for iOS can be extremely painful as the feedback cycle (time from save to test results) is just too slow. The slow downs come from things like building lots of source code, code signing and simulator startup.
+
+This tool can help in certain cases to get feedback cycles to acceptable levels. The basic idea is that you manually (sounds painful but it's not too bad) pick the files you want to build and test, the fewer the better. Run `swift-gist` and it will create an SPM project in a tmp directory that links to just the files you specify and then starts to watch these files and run tests whenever a file is saved. The heavy lifting is picked up by SPM so this means you cannot specify files that `import UIKit`. It's also advisable to keep dependencies to a minimum (which I guess is just normally good advice).
+
+---
+
+## Usage
+
+Invoke the `swift-gist` command and tell it about how you want your project set up (you can always save this command in a nice shell script for reuse later).
+
+The first argument should be either `--module` or `--test-module` followed by a name for the module. It's best to mirror your projects current module naming e.g. if I have a project called `MyApp` then I would use `--module MyApp` as the tests will be looking to `import MyApp`.
+
+After you have defined a module you should add some source code. You can invoke `--source` with quoted globs (quoted so that your shell does not automatically expand them) as many times as you like. The globs will be expanded with the resulting paths being combined and added to the last defined module.
+
+Finally you can have as many `--depends-on` arguments as you like. Multiple invocations will be added to the last defined module. On a simple project you'll need to use this to tell the test module about the module it is testing.
+
+That was a lot of text - how about an example.
+
+Given this project:
+
+```
+MyApp
+├── Source
+│   └── FeatureA
+│       ├── ...
+│       ├── hundreds of other files
+│       ├── ...
+│       └── ImportantClass.swift
+└── Tests
+    └── FeatureA
+        ├── ...
+        ├── hundreds of other files
+        ├── ...
+        └── ImportantClassTests.swift
+```
+
+If I am looking to do a tight TDD loop on the `ImportantClass` file and it only depends on `Foundation` I can use the following invocation.
+
+```
+swift-gist --module MyApp \
+           --source 'Source/Feature/ImportantClass.swift' \
+           --test-module MyAppTests \
+           --source 'Tests/Feature/ImportantClassTests.swift' \
+           --depends-on MyApp
+```
+
+This will cause my shell to start watching for file saves. Every time a file is saved it will run the unit tests.
+
+---
+
+## Installation
+
+`gem install swift-gist`
+
+---
+
+## Why make this tool?
+
+TDD really requires sub second cycle times for optimal flow. Even small projects can take multiple minutes to build and test - large projects are much worse. This leads to the tendency to take bigger steps in your development flow to batch work up instead of paying the cost of a build/test cycle. This tool aims to allow you (with a little manual effort) to finely craft what you want to build and test to suit what you are working on here and now. That could be specifying a specific file or building more elaborate watches.
+
+## Why not do the whole modularization thing that is so popular right now?
+
+Personally I think the move towards modularization is great for development speed and engineering good practices like defining boundaries and isolating parts of your app. The reason for `swift-gist` is that modularization is cool but for most people it's either going to be a very slow transformation or not viable but they are still feeling pain now. This is an attempt to help sooth the pain a little without requiring a massive reshaping of your existing code base.
+
+## Why make this in Ruby?
+
+I've kept this to not using any fancy ruby dependencies, so if you are using Sierra or High Sierra you already have everything you need to use this tool. Although it's possible to write this in Swift - I think it's easier to write `gem install swift-gist` than it is to figure out how to package this for Swift.
+
+---
+
+## I found a bug - what do I do?
+
+Sweet, thanks for trying this tool out - could you spare some time to raise an issue? Likelihood is it's because the tool is a rough proof of concept and needs hardening to common issues and better documentation.
+
+If you can write ruby - submit a PR and I'll be happy to look at it. If you are going to write a massive PR it might be worth discussing the proposed changes first to avoid disappointment if the changes don't get accepted.

data/bin/swift-gist

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "bundler/setup"
 require "swift/gist"
 
-Swift::Gist::run ARGV
+exit Swift::Gist::run(ARGV)

data/lib/swift/gist/generate_project.rb

@@ -0,0 +1,23 @@
+module Swift
+  module Gist
+
+    def self.generate_project(
+      swift_modules,
+      mktmpdir: Dir.method(:mktmpdir),
+      open: File.method(:open),
+      spm_package_creator: method(:spm_package_definition_from_swift_modules),
+      spm_project_creator: method(:spm_project_from_swift_modules)
+    )
+
+      mktmpdir.call.tap do |tmp_dir|
+        spm_project_creator.call swift_modules, tmp_dir: tmp_dir
+
+        open.call("#{tmp_dir}/Package.swift", 'w') do |file|
+          file.puts spm_package_creator.call(swift_modules)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/swift/gist/generate_project_art.rb

@@ -0,0 +1,22 @@
+module Swift
+  module Gist
+    def self.generate_project_art swift_modules, tmp_dir
+      description = StringIO.new
+      description.puts tmp_dir
+      description.puts '.'
+      description.puts "├── Package.swift"
+      description.puts "└── Sources"
+      swift_modules.sort_by { |swift_module| swift_module.name }.each_with_index do |swift_module, index|
+        description.print index == swift_modules.length - 1 ? "    └── " : "    ├── "
+        description.puts swift_module.name
+
+        swift_module.sources.sort.each_with_index do |source, source_index|
+          description.print index == swift_modules.length - 1               ? "     " : "    │"
+          description.print source_index == swift_module.sources.length - 1 ? "   └── " : "   ├── "
+          description.puts source
+        end
+      end
+      description.string
+    end
+  end
+end

data/lib/swift/gist/runner.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'time'
 require 'tmpdir'
 
 module Swift
@@ -8,35 +9,41 @@ module Swift
     #
     # 1 - Parses command line arguments
     # 2 - Creates a SPM project linking just the files specified with `--source` arguments
-    # 3 - Starts watchman
     def self.run(
       arguments,
       chdir: Dir.method(:chdir),
       cli: method(:parse_command_line_arguments),
-      mktmpdir: Dir.method(:mktmpdir),
-      open: File.method(:open),
-      pwd: Dir.method(:pwd),
-      spm_package_creator: method(:spm_package_definition_from_swift_modules),
-      spm_project_creator: method(:spm_project_from_swift_modules),
+      formatted_date: -> { Time.iso8601(Time.now.iso8601) },
+      project_art_generator: method(:generate_project_art),
+      project_generator: method(:generate_project),
+      rm_rf: FileUtils.method(:rm_rf),
       system: method(:system),
-      watchman_command: method(:watchman_command)
+      stdout: $stdout.method(:puts),
+      watcher: method(:watch_sources)
     )
 
       swift_modules = cli.call arguments
-      project_dir   = pwd.call
+      tmp_dir = project_generator.call(swift_modules)
+      stdout.call project_art_generator.call(swift_modules, tmp_dir)
 
-      mktmpdir.call do |tmp_dir|
-        chdir.call(tmp_dir) do
-          spm_project_creator.call swift_modules, project_dir: project_dir
+      chdir.call(tmp_dir) do
+        system.call('swift test')
+      end
 
-          open.call('Package.swift', 'w') do |file|
-            file.puts spm_package_creator.call(swift_modules)
-          end
+      counter = 1
+      watcher.call(swift_modules) do
+        stdout.call "\n\n-----> Running `$ swift test` @ '#{formatted_date.call}' - Build ##{counter}"
+        chdir.call(tmp_dir) do
+          system.call('swift test')
         end
 
-        system.call(watchman_command.call(tmp_dir, swift_modules))
+        counter += 1
       end
 
+      0
+
+    ensure
+      rm_rf.call tmp_dir
     end
 
   end

data/lib/swift/gist/spm_project_creator.rb

@@ -3,15 +3,16 @@ module Swift
 
     def self.spm_project_from_swift_modules(
       swift_modules,
-      project_dir:,
+      tmp_dir:,
       mkdir_p: FileUtils.method(:mkdir_p),
+      pwd: Dir.method(:pwd),
       ln_s: FileUtils.method(:ln_s)
     )
 
       swift_modules.each do |swift_module|
-        mkdir_p.call "Sources/#{swift_module.name}"
+        mkdir_p.call "#{tmp_dir}/Sources/#{swift_module.name}"
         swift_module.sources.each do |source|
-          ln_s.call "#{project_dir}/#{source}", "Sources/#{swift_module.name}"
+          ln_s.call "#{pwd.call}/#{source}", "#{tmp_dir}/Sources/#{swift_module.name}"
         end
       end
     end

data/lib/swift/gist/swift_module.rb

@@ -6,10 +6,6 @@ module Swift
       def initialize name, type, sources, depends_on=[]
         @name, @type, @sources, @depends_on = name, type, sources, depends_on
       end
-
-      def == other
-        name == other.name && sources == other.sources && depends_on == other.depends_on && type == other.type
-      end
     end
   end
 end

data/lib/swift/gist/version.rb

@@ -1,5 +1,5 @@
 module Swift
   module Gist
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/swift/gist/watcher.rb

@@ -0,0 +1,17 @@
+require 'listen'
+
+module Swift
+  module Gist
+    def self.watch_sources swift_modules, listener: Listen, sleep: method(:sleep)
+      sources = Set.new(swift_modules.map { |swift_module| swift_module.sources }.flatten)
+      dirs    = Set.new(sources.map { |path| Dir.exist?(path) ? path : File.dirname(path) })
+
+      listener.to(*dirs, only: /.*swift/, relative: true) do |modified, created, deleted|
+        next unless sources.intersect?(Set.new(modified + created + deleted))
+        yield
+      end.start
+
+      sleep.call
+    end
+  end
+end

data/lib/swift/gist.rb

@@ -5,10 +5,11 @@ end
 
 require "swift/gist/cli"
 require "swift/gist/format_swift_module"
+require "swift/gist/generate_project"
+require "swift/gist/generate_project_art"
 require "swift/gist/runner"
 require "swift/gist/spm_package_creator"
 require "swift/gist/spm_project_creator"
 require "swift/gist/swift_module"
 require "swift/gist/version"
-require "swift/gist/watchman_command"
-require "swift/gist/watchman_paths"
+require "swift/gist/watcher"

data/swift-gist.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency 'listen', '~> 3.1.5'
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: swift-gist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paul Samuels
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,13 +100,14 @@ files:
 - lib/swift/gist.rb
 - lib/swift/gist/cli.rb
 - lib/swift/gist/format_swift_module.rb
+- lib/swift/gist/generate_project.rb
+- lib/swift/gist/generate_project_art.rb
 - lib/swift/gist/runner.rb
 - lib/swift/gist/spm_package_creator.rb
 - lib/swift/gist/spm_project_creator.rb
 - lib/swift/gist/swift_module.rb
 - lib/swift/gist/version.rb
-- lib/swift/gist/watchman_command.rb
-- lib/swift/gist/watchman_paths.rb
+- lib/swift/gist/watcher.rb
 - swift-gist.gemspec
 homepage: https://github.com/paulsamuels/swift-gist
 licenses:

data/lib/swift/gist/watchman_command.rb

@@ -1,8 +0,0 @@
-module Swift
-  module Gist
-    def self.watchman_command dir, swift_modules, watchman_paths_from_swift_modules: method(:watchman_paths_from_swift_modules)
-      sources = watchman_paths_from_swift_modules.call(swift_modules)
-      "watchman-make -p #{sources} --run 'cd #{dir} && swift test'"
-    end
-  end
-end

data/lib/swift/gist/watchman_paths.rb

@@ -1,11 +0,0 @@
-module Swift
-  module Gist
-    def self.watchman_paths_from_swift_modules swift_modules
-      swift_modules
-      .map { |swift_module| swift_module.sources }
-      .flatten
-      .map { |path| %Q|'#{path}'| }
-      .join(' ')
-    end
-  end
-end