yop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f999a4178d91f2c183491af37837a814129fbc96
+  data.tar.gz: b5e0ecf6508e6f5635401878aee77745e28bc236
+SHA512:
+  metadata.gz: 4b77f2388b91267826ad6bfe1fa3b6c5a3446be04ed41b417f49e470c224ea9322ccf654a0efda9896d9cc29d8716d4d2e20d8bb844ada5168a6e73ece27cb3a
+  data.tar.gz: afa79f8dd233a9b50177e999e3b54acb37f101cc91b22d3ab1a1ab55086deea802ee8130e8c5e3683f5f5315045631d755bce97ecb41e04bc5ec8d900d8cad53

data/bin/yop

@@ -0,0 +1,50 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+
+# clean interrupt
+trap("INT") { abort }
+
+require "trollop"
+require "yop"
+
+Yop.init
+
+opts = Trollop.options do
+  version "yop #{Yop.version}"
+  banner <<-EOS
+Yop bootstraps your projects with predefined templates.
+
+Usage:
+    yop [options] <template> <directory>
+
+  * <template> is a template name. Use --templates to list all of them
+  * <directory> is any directory. It’ll be created if it doesn’t exist
+
+Options:
+EOS
+
+  opt :templates, "List all available templates", default: false
+end
+
+if opts[:templates]
+  require "pathname"
+
+  puts "Templates:"
+  Yop.templates.each do |t|
+    puts "* #{Pathname.new(t).basename}"
+  end
+  exit 0
+end
+
+Trollop.educate unless ARGV.length == 2
+
+template, directory = ARGV
+
+puts "Applying template '#{template}' on #{directory}..."
+begin
+  Yop.bootstrap(template, directory)
+rescue NonExistentTemplate => e
+  puts "ERROR: The template '#{e}' doesn’t exist."
+  exit 1
+end
+puts "Done!"

data/lib/yop/bootstrap.rb

@@ -0,0 +1,16 @@
+# -*- coding: UTF-8 -*-
+
+require_relative "templates"
+
+module Yop
+  class << self
+    # Bootstrap a project (which will be) located in `directory` with the
+    # template `template`
+    # @param template [String] the template name
+    # @param directory [String] the directory path
+    # @return nil
+    def bootstrap(template, directory)
+      get_template(template).apply directory
+    end
+  end
+end

data/lib/yop/config.rb

@@ -0,0 +1,43 @@
+# -*- coding: UTF-8 -*-
+
+require "yaml"
+
+require_relative "home"
+
+module Yop
+  class << self
+    # Get the local Yop config. If no argument is given the whole config is
+    # returned. If one is given, the corresponding value is returned.
+    # @param key [Any] the key to lookup
+    # @return [Any] either the whole config or the value for `key`
+    def config(key = nil)
+      read_config unless @conf
+
+      if !key.nil?
+        @conf[key]
+      else
+        @conf
+      end
+    end
+
+    # Set variables in the local Yop config.
+    # @param opts [Hash] an hash which will be merged into the local config
+    # @return nil
+    def config!(opts = {})
+      @conf.update(opts)
+      save_config
+    end
+
+    private
+
+    def read_config
+      @conf = YAML.load_file(home("config.yml")) || {}
+    end
+
+    def save_config
+      File.open(home("config.yml"), "w") do |f|
+        f.write YAML.dump(@conf)
+      end
+    end
+  end
+end

data/lib/yop/exceptions.rb

@@ -0,0 +1,4 @@
+# -*- coding: UTF-8 -*-
+
+# This exception is raised when get_template fails to find a template
+class NonExistentTemplate < Exception; end

data/lib/yop/home.rb

@@ -0,0 +1,23 @@
+# -*- coding: UTF-8 -*-
+
+require "fileutils"
+
+module Yop
+  class << self
+    # Return the local Yop directory location. If an argument is given, it
+    # assumes it's a Yop subcomponent and returns its location.
+    # @param subcomponent [String] the subcomponent to look for
+    # @return [String] the path to the local Yop directory or its subcomponent
+    def home(subcomponent = "")
+      File.expand_path("~/.yop/#{subcomponent}")
+    end
+
+    # Initialize Yop's local directory
+    # @return nil
+    def init
+      FileUtils.mkdir_p home
+      FileUtils.mkdir_p home("templates")
+      FileUtils.touch home("config.yml")
+    end
+  end
+end

data/lib/yop/templates.rb

@@ -0,0 +1,96 @@
+# -*- coding: UTF-8 -*-
+
+require "fileutils"
+
+require_relative "home"
+require_relative "config"
+require_relative "exceptions"
+
+module Yop
+  class << self
+    # @return [Array] all the available templates
+    def templates
+      Dir["#{Yop.home("templates")}/*"]
+    end
+
+    # Retrieve a template from its name, or raise a `NonExistentTemplate`
+    # exception if it doesn't exist
+    # @param name [String] the template name
+    # @return [Yop::Template]
+    def get_template(name)
+      dirs = Dir["#{Yop.home("templates")}/#{name}"]
+      fail NonExistentTemplate, name if dirs.empty?
+      Template.new(dirs.first, config(:vars) || {})
+    end
+  end
+
+  # A Yop Template, which consists of a base directory and an hash of variables
+  class Template
+    include FileUtils
+
+    # Create a new template from a base directory
+    # @param base_directory [String] a path to an existing directory which will
+    #                                be used as a source when this template
+    #                                will be applied
+    # @param vars [Hash]
+    def initialize(base_directory, vars = {})
+      @base = base_directory
+      @vars = vars
+    end
+
+    # Apply the template on a directory. It creates it if it doesn't exist,
+    # then recursively copies itself in it
+    # @param directory [String] the directory in which to copy
+    # @return nil
+    def apply(directory)
+      mkdir_p directory
+
+      # get relative paths
+      sources = []
+      cd(@base) { sources = Dir["**/*", "**/.*"] }
+
+      cd directory do
+        sources.each do |path|
+          next if skip? path
+
+          source = "#{@base}/#{path}"
+
+          if File.directory? source
+            mkdir_p path
+          elsif File.file? source
+            File.open(path, "w") do |f|
+              content = replace_vars source
+              f.write(content)
+            end
+          else
+            puts "Warning: unsupported file: #{source}"
+            next
+          end
+          mirror_perms source, path
+        end
+      end
+    end
+
+    private
+
+    def ignore_extension?(path)
+      %w[.swp .swo .pyc .class].any? { |e| path.end_with?(e) }
+    end
+
+    def skip?(path)
+      return true if ignore_extension? path
+
+      [/\.git/, /.~$/, /__pycache__/].any? { |reg| path =~ reg }
+    end
+
+    def replace_vars(source)
+      # TODO
+      File.read(source)
+    end
+
+    def mirror_perms(source, target)
+      mode = File.new(source).stat.mode
+      File.chmod(mode, target)
+    end
+  end
+end

data/lib/yop/version.rb

@@ -0,0 +1,8 @@
+# -*- coding: UTF-8 -*-
+
+module Yop
+  # @return [String] the current gem's version
+  def self.version
+    "0.0.1"
+  end
+end

data/lib/yop.rb

@@ -0,0 +1,9 @@
+# -*- coding: UTF-8 -*-
+
+# Base module for Yop
+module Yop; end
+
+require_relative "yop/bootstrap"
+require_relative "yop/home"
+require_relative "yop/templates"
+require_relative "yop/version"

data/tests/tests.rb

@@ -0,0 +1,32 @@
+#! /usr/bin/env ruby
+# -*- coding: UTF-8 -*-
+
+require "coveralls"
+Coveralls.wear!
+
+require "test/unit"
+require "simplecov"
+
+test_dir = File.expand_path(File.dirname(__FILE__))
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start { add_filter "/tests/" }
+
+require "yop"
+
+for t in Dir[File.join(test_dir,  "*_tests.rb")]
+  require t
+end
+
+class YopTests < Test::Unit::TestCase
+
+  # == #version == #
+
+  def test_version
+    assert(Yop.version =~ /^\d+\.\d+\.\d+/)
+  end
+
+end
+
+
+exit Test::Unit::AutoRunner.run

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: yop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Baptiste Fontaine
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDaDCCAlCgAwIBAgIBATANBgkqhkiG9w0BAQUFADA9MRAwDgYDVQQDDAdiYXRp
+  Zm9uMRUwEwYKCZImiZPyLGQBGRYFeWFob28xEjAQBgoJkiaJk/IsZAEZFgJmcjAe
+  Fw0xNDA4MjQxMTM5NTJaFw0xNTA4MjQxMTM5NTJaMD0xEDAOBgNVBAMMB2JhdGlm
+  b24xFTATBgoJkiaJk/IsZAEZFgV5YWhvbzESMBAGCgmSJomT8ixkARkWAmZyMIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAn3uOgWl+FwXIjDdCay28i6cK
+  FxHWhHoS/mH9pkXzSGVctEKP2fulie6MkIvrLCP5M6TpByeaBjcJjZPadrou1FIc
+  Yc/O14jYjaKTqfMxpzgNfGzDdBgBo0QZ9rcHjORetdIZdUSDaZjPtI1aGS6eBMsh
+  W2X6GxL4UQ1kH0Lyg7iPYAH5RHnD3+G+S28iOPFfRLFzm4fwJp1k7URiiSyOHTDp
+  B0ZehKKrW/ibCaRMYp2VoCamcim4de1VA6CTOaYSShueqThE18n1HM6aprihziyM
+  04yIpo80/unO6JxlsUFdBjsb5d7oJSqPJ6/OfcFnyXa/VRm+Ed9d6PTwZvL7YwID
+  AQABo3MwcTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUWyH3xMx1
+  8I5NLncgNEC0ZlDRKegwGwYDVR0RBBQwEoEQYmF0aWZvbkB5YWhvby5mcjAbBgNV
+  HRIEFDASgRBiYXRpZm9uQHlhaG9vLmZyMA0GCSqGSIb3DQEBBQUAA4IBAQAaTVya
+  CGgojxBwUoadCCIsFheGsXvSFhikkXYNXy0VxEYr8BaTfGwzYh9c9T5N+Y5Mu5MW
+  WegqwIwRhIu6Rg7huqJ7TK50pVDF0yrZcsxvWjOfd3clblBHjKGQx5Mbu7LVNGKE
+  +QNdTAwYVTAA8wXHpxk200cHb9xz4e9ANpb4lonGuPz8jKmb/A7Z1M5QD6zStG8l
+  sTlVAhA/LZiC9gL9LtW8Iq7o7xRFhxNPKWHu6JVThH9i16eli+JignOJbGna7C40
+  QnOQb8zHyNL+gq2m/mnZGrSehx+6AujokjOfHbmivYMfDATOQQx0eIBI18IhacZm
+  42WxhhIV2bwDtd77
+  -----END CERTIFICATE-----
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+description: Yop bootstraps your projects from pre-defined templates
+email: b@ptistefontaine.fr
+executables:
+- yop
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/yop
+- lib/yop.rb
+- lib/yop/bootstrap.rb
+- lib/yop/config.rb
+- lib/yop/exceptions.rb
+- lib/yop/home.rb
+- lib/yop/templates.rb
+- lib/yop/version.rb
+- tests/tests.rb
+homepage: https://github.com/bfontaine/Yop
+licenses:
+- MIT
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Templates-based projects manager
+test_files:
+- tests/tests.rb
+has_rdoc: