ftpeter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecc761a5a1d0acb90260ac556b71f69f1025aa7b
-  data.tar.gz: c790862e26ba4bc5d70dfd84130c1cf9374442d9
+  metadata.gz: c86268cfe83c63b53a5342410956738fbeaef88b
+  data.tar.gz: 02fa1e3409a5f3ecbc39378294b0716f886eccbd
 SHA512:
-  metadata.gz: 3592f65606899aad4fc279a9966413018e85cdfbd08537ea22d8cbaf3542cc9f8b124b01de2e9642bb7ce471830946bbac06bce97b4f610d45d2359de459689f
-  data.tar.gz: 4ca49adb7d7b27a490c941375722c4330a5ca675fb69f8be0480627edcf3a5c098bab6ee9ccc649b977d6cc7c9ac014fe5e0566a8d1bb5325deeadcbb10fafce
+  metadata.gz: 10bae2b564422d92537198d048d16fbeb5477863e3cfd4a2b6ea4a19842a515eb4ffb6cd2c997c63ef912780fc0b54ac1282233509a27aacfde99d6f1c95d7df
+  data.tar.gz: 20fe5332c67d3744ca8c8feea384998406be4e17dc255149d023905aaac368e41767b21f528bbdac1761e69347ae45fc258dfd1d9cf3c4f1e03f12b00a2eebd4

data/.rubocop.yml

@@ -0,0 +1,33 @@
+inherit_from: .rubocop_todo.yml
+
+# Style Choices
+
+Metrics/LineLength:
+  Max: 100
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%r': ~~
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+# Rejection of nonsensical Rules and things I don't care about
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,34 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-09-04 12:22:39 +0200 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 25
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 24
+
+# Offense count: 7
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/ftpeter.rb'
+    - 'lib/ftpeter/backend.rb'
+    - 'lib/ftpeter/backend/git.rb'
+    - 'lib/ftpeter/cli.rb'
+    - 'lib/ftpeter/transport.rb'
+    - 'lib/ftpeter/transport/lftp.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/ftpeter/cli.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+ftpeter

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/Gemfile

@@ -1,4 +1,10 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ftpeter.gemspec
 gemspec
+
+group :development do
+  gem 'guard-rubocop'
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :rubocop do
+  watch(%r~.+\.rb$~)
+  watch(%r~.+\.gemspec$~)
+  watch(%r~(Rake|Gem)file$~)
+  watch(%r~(?:.+/)?\.rubocop\.yml$~) { |m| File.dirname(m[0]) }
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -57,7 +57,7 @@ https://git.lanpartei.de/kronn/ftpeter
 
 ## License
 
-"MIT-alike, not no military usage and no sublicensing"
+"MIT-alike, but no military usage and no sublicensing"
 
 
 Copyright (c) 2015 Matthias Viehweger

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "ftpeter"
+require 'bundler/setup'
+require 'ftpeter'
 
 # 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.
@@ -10,5 +11,5 @@ require "ftpeter"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/exe/ftpeter

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "ftpeter/cli"
+require 'ftpeter/cli'
 
 Ftpeter::CLI.new(ARGV).go

data/ftpeter.gemspec

@@ -1,24 +1,32 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ftpeter/version"
+require 'ftpeter/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ftpeter"
+  spec.name          = 'ftpeter'
   spec.version       = Ftpeter::VERSION
-  spec.authors       = ["Matthias Viehweger"]
-  spec.email         = ["kronn@kronn.de"]
+  spec.authors       = ['Matthias Viehweger']
+  spec.email         = ['kronn@kronn.de']
 
-  spec.summary       = %q{Deployments via FTP}
-  spec.description   = %q{Upload or delete files that have changed in git using lftp. lftp supports ftp, ftps, sftp and more.}
-  spec.homepage      = "https://git.lanpartei.de/kronn/ftpeter"
-  spec.license       = "MIT"
+  spec.summary       = 'Deployments via FTP'
+  spec.description   = <<-EODESC
+Upload or delete files that have changed in git using lftp.
+lftp supports ftp, ftps, sftp and more.
+  EODESC
+  spec.homepage      = 'https://git.lanpartei.de/kronn/ftpeter'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`
+                         .split("\x0")
+                         .reject { |f| f.match(%r~^(test|spec|features)/~) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r~^exe/~) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/ftpeter/backend/git.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Ftpeter
+  module Backend
+    class Git
+      attr_reader :changes
+
+      def initialize(last)
+        # build up diff since last version
+        files = `git log #{last}... --name-status --oneline`.split("\n")
+        deleted = files.grep(/^[RD]/).map { |l| l.gsub(/^[RD]\s+/, '') }.uniq
+        changed = files.grep(/^[ACMR]/).map { |l| l.gsub(/^[ACMR]\s+/, '') }.uniq
+        added   = files.grep(/^[A]/).map { |l| l.gsub(/^[A]\s+/, '') }.uniq
+
+        @changes = Ftpeter::Changes.new(deleted, changed, added)
+      end
+    end
+  end
+end

data/lib/ftpeter/backend.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Ftpeter
+  module Backend
+    autoload :Git, 'ftpeter/backend/git'
+  end
+end

data/lib/ftpeter/changes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Ftpeter
+  Changes = Struct.new(:deleted, :changed, :added) do
+    def newdirs
+      @newdirs ||= added
+                     .map { |fn| Pathname.new(fn).dirname.to_s }
+                     .uniq
+                     .reject { |fn| fn == '.' }
+    end
+  end
+end

data/lib/ftpeter/cli.rb

@@ -1,94 +1,65 @@
-require "pathname"
+# frozen_string_literal: true
+require 'pathname'
 
 module Ftpeter
   class CLI
     def initialize(args)
-      raise ArgumentError, "Please specify a host to deploy to" unless args[0]
+      raise ArgumentError, 'Please specify a host to deploy to' unless args[0]
 
       @host = args[0]
-      @dir  = args[1] || "/" # the directory to change into
-      @last = args[2] || "origin/master" # get the last deployed version and current version
+      @dir  = args[1] || '/' # the directory to change into
+      @last = args[2] || 'origin/master' # get the last deployed version
 
       configure
     end
 
+    # TODO: extract code into Connection-class
     def configure
-      cleaned_host = if @host =~ %r!//!
-                        require "uri"
-                        URI(@host).host
-                      else
-                        @host
-                      end
+      cleaned_host = if @host =~ %r~//~
+                       require 'uri'
+                       URI(@host).host
+                     else
+                       @host
+                     end
 
       @credentials = begin
                        `grep #{cleaned_host} ~/.netrc`.chomp
                          .split("\n").first
                          .match(/login (?<user>\S+) password (?<pass>\S+)/)
-                     rescue NoMethodError => e
+                     rescue NoMethodError
                        nil
                      end
 
       @commands    = begin
-                       Pathname.new("./.ftpeterrc").read.chomp
-                     rescue Errno::ENOENT=> e
+                       Pathname.new('./.ftpeterrc').read.chomp
+                     rescue Errno::ENOENT
                        nil
                      end
+
+      @connection = Ftpeter::Connection.new(
+        @host,
+        @credentials,
+        @dir,
+        @commands
+      )
     end
 
     def go
-      # internal vars
-      lftp_script = []
-      lftp_fn = Pathname.new("./lftp_script").expand_path
-
-      # build up diff since last version
-      files = `git log #{@last}... --name-status --oneline`.split("\n")
-      deleted = files.grep(/^[RD]/).map { |l| l.gsub(/^[RD]\s+/, "") }.uniq
-      changed = files.grep(/^[ACMR]/).map { |l| l.gsub(/^[ACMR]\s+/, "") }.uniq
-      added   = files.grep(/^[A]/).map { |l| l.gsub(/^[A]\s+/, "") }.uniq
-      newdirs = added.map { |fn| Pathname.new(fn).dirname.to_s }.uniq.reject { |fn| fn == "." }
-
-      # lftp connection header
-      lftp_script << "open #{@host}"
-      lftp_script << "user #{@credentials["user"]} #{@credentials["pass"]}" if @credentials
-      lftp_script << "cd #{@dir}"
-
-      # lftp file commands
-      lftp_script << deleted.map do |fn|
-        "rm #{fn}"
-      end
-      lftp_script << newdirs.map do |fn|
-        "mkdir -p #{fn}"
-      end
-      lftp_script << changed.map do |fn|
-        "put #{fn} -o #{fn}"
-      end
-      lftp_script << @commands.split("\n").map do |cmd|
-        "!#{cmd}"
-      end if @commands
-      lftp_script << '!echo ""'
-      lftp_script << '!echo "Deployment complete"'
-
-      # write script to file
-      lftp_fn.open("w") do |f|
-        f << lftp_script.flatten.join("\n")
-        f << "\n"
-      end
+      changes = get_changes_from(:git)
+      upload  = transport(changes).via(@connection, :lftp)
 
-      puts "="*80
-      puts lftp_fn.read
-      puts "="*80
-      puts
+      $stdout.puts '=' * 80, upload.inform, '=' * 80, nil
+      upload.persist
 
       if okay?
-        `lftp -f #{lftp_fn}`
-        lftp_fn.delete
+        upload.execute and upload.cleanup
       else
-        puts "#{lftp_fn} is left for your editing pleasure"
+        $stdout.puts "#{upload.script} is left for your editing pleasure"
       end
     end
 
-    def confirm(confirmation = "yes")
-      $stderr.print "[yes, No] > "
+    def confirm(confirmation = 'yes')
+      $stderr.print '[yes, No] > '
 
       if $stdin.gets.chomp != confirmation
         raise "you did not enter '#{confirmation}', aborting"
@@ -98,12 +69,22 @@ module Ftpeter
     end
 
     def okay?
-      $stderr.puts "is this script okay?"
+      $stdout.puts 'is this script okay?'
       begin
-        confirm("yes")
+        confirm('yes')
       rescue RuntimeError
         false
       end
     end
+
+    def get_changes_from(vcs)
+      raise ArgumentError, "There's only git-support for now" unless vcs == :git
+
+      Ftpeter::Backend::Git.new(@last).changes
+    end
+
+    def transport(changes)
+      Ftpeter::Transport.new(changes)
+    end
   end
 end

data/lib/ftpeter/connection.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Ftpeter
+  Connection = Struct.new(:host, :credentials, :dir, :commands)
+end

data/lib/ftpeter/transport/lftp.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+require 'pathname'
+
+module Ftpeter
+  class Transport
+    class Lftp
+      attr_reader :script
+
+      def initialize(connection, changes)
+        @changes = changes
+        @lftp_script = []
+        @script = Pathname.new('./lftp_script').expand_path
+
+        @host = connection.host
+        @credentials = connection.credentials
+        @dir = connection.dir
+        @commands = connection.commands
+
+        prepare
+      end
+
+      def prepare
+        # lftp connection header
+        @lftp_script << "open #{@host}"
+        if @credentials
+          @lftp_script << "user #{@credentials['user']} #{@credentials['pass']}"
+        end
+        @lftp_script << "cd #{@dir}"
+
+        # lftp file commands
+        @lftp_script << @changes.deleted.map do |fn|
+          "rm #{fn}"
+        end
+        @lftp_script << @changes.newdirs.map do |fn|
+          "mkdir -p #{fn}"
+        end
+        @lftp_script << @changes.added.map do |fn|
+          "put #{fn} -o #{fn}"
+        end
+        @lftp_script << @changes.changed.map do |fn|
+          "put #{fn} -o #{fn}"
+        end
+        @lftp_script << @commands.split("\n").map do |cmd|
+          "!#{cmd}"
+        end if @commands
+        @lftp_script << '!echo ""'
+        @lftp_script << '!echo "Deployment complete"'
+
+        @lftp_script.flatten!.compact!
+
+        @lftp_script
+      end
+
+      def commands
+        @lftp_script
+      end
+
+      def inform
+        @lftp_script.join("\n")
+      end
+
+      def persist
+        script.open('w') do |f|
+          f << @lftp_script.flatten.join("\n")
+          f << "\n"
+        end
+      end
+
+      def execute
+        system("lftp -f #{script}")
+      end
+
+      def cleanup
+        script.delete
+      end
+    end
+  end
+end

data/lib/ftpeter/transport.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Ftpeter
+  class Transport
+    class Unsupported < ArgumentError
+      def message
+        'There is only lftp-support for now'
+      end
+    end
+
+    autoload :Lftp, 'ftpeter/transport/lftp'
+
+    def initialize(changes)
+      @changes = changes
+    end
+
+    def via(connection, uploader)
+      raise Unsupported unless uploader == :lftp
+
+      Ftpeter::Transport::Lftp.new(connection, @changes)
+    end
+  end
+end

data/lib/ftpeter/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Ftpeter
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/ftpeter.rb

@@ -1,9 +1,17 @@
-require "ftpeter/version"
-require "pathname"
+# frozen_string_literal: true
+# TODO: check if needed here (they shouldn't be)
+require 'pathname'
 
-# TODO extract git-backend to detect changes
-# TODO extract lftp-backend to deploy files
-# TODO setup help and option-parsing
+# TODO: setup help and option-parsing
 module Ftpeter
-  autoload :CLI, "ftpeter/cli"
+  autoload :CLI, 'ftpeter/cli'
+  autoload :VERSION, 'ftpeter/version'
+
+  # value classes
+  autoload :Changes, 'ftpeter/changes'
+  autoload :Connection, 'ftpeter/connection'
+
+  # collection of plugable components
+  autoload :Transport, 'ftpeter/transport'
+  autoload :Backend, 'ftpeter/backend'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ftpeter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthias Viehweger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2016-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Upload or delete files that have changed in git using lftp. lftp supports
-  ftp, ftps, sftp and more.
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Upload or delete files that have changed in git using lftp.
+  lftp supports ftp, ftps, sftp and more.
 email:
 - kronn@kronn.de
 executables:
@@ -63,8 +92,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
 - bin/console
@@ -72,7 +106,13 @@ files:
 - exe/ftpeter
 - ftpeter.gemspec
 - lib/ftpeter.rb
+- lib/ftpeter/backend.rb
+- lib/ftpeter/backend/git.rb
+- lib/ftpeter/changes.rb
 - lib/ftpeter/cli.rb
+- lib/ftpeter/connection.rb
+- lib/ftpeter/transport.rb
+- lib/ftpeter/transport/lftp.rb
 - lib/ftpeter/version.rb
 homepage: https://git.lanpartei.de/kronn/ftpeter
 licenses:
@@ -94,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Deployments via FTP