podmode 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fc4643d12cf7b8ee78c6e93bcba96d95cddd394
+  data.tar.gz: 121a7639199cf119bf1bd93f1e2749969f1367a3
+SHA512:
+  metadata.gz: d01f0cd860e85a198854377a6a4dbb849e6bf3bdddcc6fefbe6958c5c1fbf8beb006854ea63de4b421cf364c5af6b4a63c5d83d7b8cbe38281274cae7d280028
+  data.tar.gz: e1ba1a512bcdcf6c10bdc89bd674d030d25bb7c0ee6e64b4f05bcf26899fc1903cb63775560517580e6695f82468c4ab051ca2872a54c61757c0d33b2df4fbb0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Toine Heuvelmans
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Podmode
+
+Podmode is a small tool that allows you to easily specify a local directory for a development pod when using Cocoapods. You can dynamically switch between using the local project or checking out the project from its remote source url.
+
+It allows for different configurations without needing to alter the Podfile. Across developers the local path will vary, and the CI server will likely need to check out the project from the server.
+
+## Installation
+
+You can install the gem as follows:
+
+    $ gem install ./podmode-0.1.0.gem
+    
+You might need to install `dotenv` too:
+
+    $ gem install dotenv
+    
+### Troubleshooting
+
+It might be that you run into trouble when running podmode. Make sure the required directory is created, by executing:
+
+```bash
+mkdir -p ~/.touchwonders/podmodes/
+```
+    
+## Defining a Podmode for a local project
+
+In the terminal, navigate to a project directory that contains a podspec. You can run `podmode` to see available options.
+
+Run the following to create a `podmode` for your project:
+
+```bash
+podmode create YourProject
+```
+
+You'll be asked to specify a mode. Select 1: local.
+
+You'll then be asked to specify the path. You can enter `.` to specify the current directory.
+
+In the Podfile that needs to include your project, you can specify the podmode as follows:
+
+```
+require 'podmode'
+...
+pod 'YourProject', Podmode::Podmode.new('YourProject', 'git@gitlab.api-touchwonders.com:components/yourproject.git').options()
+...
+```
+
+This will ensure the Podfile will target the local directory that you specified for your project.
+
+## Other modes
+
+You can specify a different pod mode on creation or when editing an existing `podmode`.
+
+### Auto
+
+Will use the git url specified in the Podfile (see above), using the default branch.
+
+### Branch
+
+Will use the git url specified in the Podfile, using the branch specified in the `podmode`.
+
+### Tag
+
+Will use the git url specified in the Podfile, using the tag specified in the `podmode`.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "podmode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/podmode

@@ -0,0 +1,183 @@
+#!/usr/bin/env ruby
+
+require "cocoapods"
+require "podmode"
+require "fileutils"
+
+module Podmode
+
+	def self.run()
+		action = ARGV[0]
+		action_method = action_method(action)
+		if action_method.nil?
+			help()
+		else
+			action_method.call()
+		end
+	end
+
+	def self.help()
+		puts "Specify one of the following actions:\n\n"
+		actions().each do |action_method, desc|
+			puts "    #{String(action_method.name).ljust(10)}#{desc}"
+		end
+	end
+
+	def self.version()
+		puts ::Podmode::VERSION
+	end
+
+	# OPTIONS:
+
+	def self.list()
+		podmodes = available_podmodes()
+		if podmodes.size() == 0
+			puts " - No podmodes configured - "
+		else
+			podmodes.each do |podmode|
+				puts "- #{podmode[:name]}"
+				puts "      path: #{podmode[:path]}"
+				puts "      contents:"
+				podmode[:contents].lines.each { |l| puts (' ' * 10) + l }
+				puts "\n"
+			end
+		end
+	end
+
+	def self.create()
+		name = ARGV[1]
+		if name.nil?
+			puts "Required name attribute is missing. [podmode create NAME]"
+			return
+		end
+		name = name.strip
+		path = podmode_filepath(name)
+
+		if File.file?(path)
+			if Prompt::bool('Podmode file already exists, edit it?')
+				edit()
+			end
+			return
+		end
+		puts "Creating podmode for '#{name}'"
+		edit_podmode(name)
+		puts "Podmode created for '#{name}'"
+		print_contents(path)
+	end
+
+	def self.edit()
+		name = ARGV[1]
+		if name.nil?
+			puts "Required name attribute is missing. [podmode edit NAME]"
+			return
+		end
+		name = name.strip
+		path = podmode_filepath(name)
+
+		if File.file?(path) == false
+			if Prompt::bool('Podmode file does not exist, create it?')
+				create()
+			end
+			return
+		end
+		
+		puts "Editing podmode for '#{name}'"
+		print_contents(path)
+		edit_podmode(name)
+		puts "Podmode edited for '#{name}'"
+		print_contents(path)
+	end
+
+	def self.remove()
+		name = ARGV[1]
+		if name.nil?
+			puts "Required name attribute is missing. [podmode remove NAME]"
+			return
+		end
+		name = name.strip
+		path = podmode_filepath(name)
+		if File.file?(path) == false
+			puts "No podmode file found for #{name}, nothing removed."
+		end
+		File.delete(path)
+		puts "Podmode removed for #{name}."
+	end
+
+	# ---------------
+
+	private
+
+	def self.actions()
+		return {method(:list) =>   "Lists currently configured podmodes", 
+			    method(:create) => "Creates a new podmode;       [podmode create NAME]", 
+		 	    method(:edit) =>   "Edits an existing podmode;   [podmode edit NAME]", 
+				method(:remove) => "Removes an existing podmode; [podmode remove NAME]", 
+				method(:help) =>   "Shows the available podmode actions",
+			    method(:version) => "Prints the current version of Podmode"}
+	end
+
+	def self.action_method(action_name)
+		return if action_name.nil?
+		action_name = action_name.strip
+		actions().each do |action_method, desc|
+			if String(action_method.name) == action_name
+				return action_method
+			end
+		end
+		puts "Unknown action '#{action_name}'"
+		return nil
+	end
+
+	def self.available_podmodes()
+		dir = podmodes_dir()
+		podmodes = []
+		if File.directory?(dir)
+			Dir["#{dir}/*.podmode"].each do |podmode|
+				podmodes.push({name: File.basename(podmode, ".*"),
+							   path: podmode,
+							   contents: File.read(podmode)})
+			end
+		end
+		return podmodes
+	end
+
+	def self.podmode_filepath(name)
+		dir = podmodes_dir()
+		FileUtils::mkdir_p dir
+		return File.join(dir, "#{name.downcase}.podmode")
+	end
+
+	def self.edit_podmode(name)
+		puts "- Available modes:"
+		modes = ['auto', 'local', 'branch', 'tag']
+		modes.each_with_index {|mode, ind| puts "  [#{ind}] #{mode}"}
+		mode = Prompt::index(modes, 'Select a mode')
+
+		content = []
+		content.push("#{name.upcase}_PODMODE=#{mode}")
+
+		case mode
+			when 'local'
+				path = Prompt::prompt('Specify the local path: ')
+				fullpath = File.expand_path(path.strip)
+				content.push("#{name.upcase}_PODMODE_PATH=\"#{fullpath}\"")
+			when 'branch'
+				branch = Prompt::prompt('Specify the branch to check out: ')
+				content.push("#{name.upcase}_PODMODE_BRANCH=#{branch.strip}")
+			when 'tag'
+				tag = Prompt::prompt('Specify the tag to check out: ')
+				content.push("#{name.upcase}_PODMODE_TAG=#{tag.strip}")
+		end
+		
+		File.open(podmode_filepath(name), 'w') { |f| f.write(content.join("\n")) }
+	end
+
+	def self.print_contents(path)
+		Console::separator()
+		puts "Current contents:"
+		File.read(path).lines.each { |l| puts (' ' * 4) + l }
+		Console::separator()
+	end
+end
+
+Podmode::run()

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/podmode.rb

@@ -0,0 +1,82 @@
+require 'podmode/version'
+require 'podmode/touchwonders'
+require 'podmode/prompt'
+require 'podmode/console'
+require 'dotenv'
+
+module Podmode
+
+  	def self.podmodes_dir()
+  		return File.join(Touchwonders::config_dir(), 'podmodes')
+  	end
+
+    def self.for(name, git_url)
+      return ::Podmode::Podmode.new(name, git_url).options()
+    end
+
+  class Podmode
+  	def initialize(name, git_url)
+  		@name = name
+  		@git_url = git_url
+  	end
+
+  	def options()
+  		load()
+
+  		options = {}
+  		pod_mode = pod_mode()
+
+  		if pod_mode.nil? || pod_mode.empty? || pod_mode == 'auto'
+  			options[:git] = "ssh://#{@git_url}"
+  		else
+	  		case pod_mode
+	  			when 'local'
+	  				options[:path] = pod_path()
+
+	  			when 'branch'
+	  				options[:git] = "ssh://#{@git_url}"
+	  				options[:branch] = pod_branch()
+
+	  			when 'tag'
+	  				options[:git] = "ssh://#{@git_url}"
+	  				options[:tag] = pod_tag()
+  			end
+  		end
+
+  		return options
+  	end
+
+  	private
+
+  	def load()
+  		user_config = File.join(::Podmode.podmodes_dir(), "#{@name.downcase}.podmode")
+  		if File.exist? user_config
+  			puts "Reading #{user_config}"
+  			Dotenv.load!(user_config)
+  		end
+
+  		if File.exist? '.env.local'
+    		puts "Loading local environment variables from '.env.local'"
+    		Dotenv.overload('.env.local') 
+  		end
+  	end
+
+
+  	def pod_mode()
+  		return ENV["#{@name.upcase}_PODMODE"]
+  	end
+
+  	def pod_path
+  		return ENV["#{@name.upcase}_PODMODE_PATH"]
+  	end
+
+  	def pod_branch
+  		return ENV["#{@name.upcase}_PODMODE_BRANCH"]
+  	end
+
+  	def pod_tag
+  		return ENV["#{@name.upcase}_PODMODE_TAG"]
+  	end
+
+  end
+end

data/lib/podmode/console.rb

@@ -0,0 +1,13 @@
+require 'io/console'
+
+module Console
+
+	def self.width
+		$stdin.winsize[1]
+	end
+
+	def self.separator(str='-')
+		puts str * width
+	end
+
+end

data/lib/podmode/prompt.rb

@@ -0,0 +1,46 @@
+module Prompt
+
+	def self.prompt(*args)
+	    print(*args)
+	    STDIN.gets.chomp
+	end
+
+	def self.bool(message)
+		message = message + " (y/n): "
+		input = prompt message
+		input = input.strip
+		return input.casecmp("y") == 0 || input.casecmp("yes") == 0
+	end
+
+	def self.integer(min, max, message)
+		input = prompt "> #{message}: "
+		input = input.strip.to_i
+		if input < min || input > max
+			puts "! Specified index #{input} is outside allowed range #{min}-#{max}"
+			return integer(min, max, message)
+		else
+			return input
+		end
+	end
+
+	def self.index(options_array, message)
+		selected_index = integer(0, options_array.size - 1, message)
+		puts "selected_index: #{selected_index}"
+		puts options_array.inspect
+		return options_array[selected_index]
+	end
+
+	def self.option(options_hash, message)
+		options_hash.each { |k,v| puts "[#{k}] #{v}" }
+		input = prompt "> #{message}: "
+		input = input.strip
+
+		selected_option = options_hash[input]
+		if selected_option.nil?
+			puts "! Specified option '#{input}' is not available"
+			return option(options_hash, message)
+		else
+			return selected_option
+		end
+	end
+end

data/lib/podmode/touchwonders.rb

@@ -0,0 +1,6 @@
+module Touchwonders
+	# Will be moved to a shared "Touchwonders Toolchain" core library
+	def self.config_dir()
+  		return ENV['TOUCHWONDERS_ROOT'] || File.join(ENV['HOME'], '.touchwonders')
+  	end
+end

data/lib/podmode/version.rb

@@ -0,0 +1,3 @@
+module Podmode
+  VERSION = "0.2.0"
+end

data/podmode.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'podmode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "podmode"
+  spec.version       = Podmode::VERSION
+  spec.authors       = ["Toine Heuvelmans"]
+  spec.email         = ["toine@touchwonders.com"]
+
+  spec.summary       = "Helper for defining and interpreting Cocoapods dependency modes."
+  spec.description   = "A dependency can be local or remote. If remote, it can be a specific branch, or a specific tag."
+  spec.license       = "Nonstandard"
+  spec.homepage      = "https://www.touchwonders.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   << 'podmode'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "dotenv", "~> 2.2"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: podmode
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Toine Heuvelmans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: A dependency can be local or remote. If remote, it can be a specific
+  branch, or a specific tag.
+email:
+- toine@touchwonders.com
+executables:
+- podmode
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/podmode
+- bin/setup
+- lib/podmode.rb
+- lib/podmode/console.rb
+- lib/podmode/prompt.rb
+- lib/podmode/touchwonders.rb
+- lib/podmode/version.rb
+- podmode-0.1.0.gem
+- podmode.gemspec
+homepage: https://www.touchwonders.com
+licenses:
+- Nonstandard
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Helper for defining and interpreting Cocoapods dependency modes.
+test_files: []