railsthemes 1.2.0 → 2.0.0.pre

data/lib/railsthemes/theme_installer.rb

@@ -1,126 +1,168 @@
 module Railsthemes
-  class ThemeInstaller < Thor
-    no_tasks do
-      include Railsthemes::Logging
-      include Thor::Actions
-
-      def install_from_archive filepath
-        Railsthemes::Utils.with_tempdir do |tempdir|
-          Utils.unarchive filepath, tempdir
-          install_from_file_system tempdir
-        end
+  class ThemeInstaller
+    include Railsthemes::Logging
+
+    def install_from_archive filepath
+      Railsthemes::Utils.with_tempdir do |tempdir|
+        Utils.unarchive filepath, tempdir
+        install_from_file_system tempdir
       end
+    end
 
-      def install_from_file_system original_source_filepath
-        source_filepath = original_source_filepath.gsub(/\\/, '/')
-        logger.warn 'Installing main theme...'
-        logger.info "Source filepath: #{source_filepath}"
-
-        if File.directory?(source_filepath)
-          install_from_directory source_filepath
-        elsif Utils.archive?(source_filepath + '.tar.gz')
-          install_from_archive(source_filepath + '.tar.gz')
-        else
-          Safe.log_and_abort 'Expected either a directory or archive.'
-        end
+    def install_from_file_system original_source_filepath
+      source_filepath = original_source_filepath.gsub(/\\/, '/')
+      logger.warn 'Installing main theme...'
+      logger.info "Source filepath: #{source_filepath}"
+
+      theme_name = nil
+      if File.directory?(source_filepath)
+        theme_name = install_from_directory source_filepath
+        post_copying_changes(theme_name)
+      elsif Utils.archive?(source_filepath + '.tar.gz')
+        install_from_archive(source_filepath + '.tar.gz')
+      else
+        Safe.log_and_abort 'Expected either a directory or archive.'
       end
+    end
 
-      def install_from_directory source_filepath
-        # this file causes issues when HAML is also present, and we overwrite
-        # it in the ERB case, so safe to delete here
-        logger.debug 'removing file app/views/layouts/application.html.erb'
-        Utils.remove_file('app/views/layouts/application.html.erb')
-
-        Dir["#{source_filepath}/base/**/*"].each do |src|
-          logger.debug "src: #{src}"
-          dest = src.sub("#{source_filepath}/base/", '')
-          logger.debug "dest: #{dest}"
-          if File.directory?(src)
-            unless File.directory?(dest)
-              logger.debug "mkdir -p #{dest}"
-              FileUtils.mkdir_p(dest)
-            end
-          else
-            unless (dest =~ /overrides\.css.*/ && File.exists?(dest)) ||
-                src =~ /\/\./ # remove any pesky hidden files that crept into the archive
-              logger.debug "cp #{src} #{dest}"
-              FileUtils.cp(src, dest)
-            end
+    def copy_theme_portions source_filepath, file_mappings
+      file_mappings.each do |src_dir, dest_prefix|
+        Dir["#{source_filepath}/#{src_dir}/**/*"].each do |src|
+          dest = src.sub("#{source_filepath}", dest_prefix).sub(/^\//, '')
+          if File.file?(src) && !override?(dest) && !system_file?(src)
+            Utils.copy_ensuring_directory_exists(src, dest)
           end
         end
+      end
+    end
 
-        gem_names = Utils.gemspecs(Utils.read_file('Gemfile.lock')).map(&:name) - ['haml', 'sass']
-        install_gems_from(source_filepath, gem_names)
+    def install_from_directory source_filepath
+      copy_theme_portions source_filepath, [
+        ['controllers', 'app'],
+        ['helpers', 'app'],
+        ['layouts', 'app/views'],
+        ['stylesheets', 'app/assets'],
+        ['javascripts', 'app/assets'],
+        ['doc', ''],
+        ['images', 'app/assets'],
+        ['mailers', 'app'],
+        ['views', 'app'],
+        ['fonts', 'app/assets'],
+      ]
+
+      logger.warn 'Done installing.'
+      return Utils.read_file(File.join(source_filepath, 'theme_name')).chomp
+    end
 
-        logger.warn 'Done installing.'
+    def post_copying_changes theme_name
+      remove_unwanted_public_files
+      create_railsthemes_demo_routes
+      add_needed_gems
+      Utils.set_layout_in_application_controller theme_name
+      add_to_asset_precompilation_list theme_name
+      comment_out_formtastic_if_user_does_not_use_formtastic theme_name
+    end
 
-        post_copying_changes
+    def remove_unwanted_public_files
+      ['index', '404', '422', '500'].each do |filename|
+        Utils.remove_file "public/#{filename}.html"
       end
+    end
 
-      def install_gems_from source_filepath, gem_names
-        return unless File.directory?("#{source_filepath}/gems")
-        logger.debug "gem_names: #{gem_names * ' '}"
-        gems_that_we_can_install = Dir.entries("#{source_filepath}/gems").reject{|x| x == '.' || x == '..'}
-        logger.debug "gems_that_we_can_install: #{gems_that_we_can_install * ' '}"
-        (gem_names & gems_that_we_can_install).each do |gem_name|
-          gem_src = File.join(source_filepath, 'gems', gem_name)
-          logger.debug("copying gems from #{gem_src}")
-          Dir["#{gem_src}/**/*"].each do |src|
-            logger.debug "src: #{src}"
-            dest = src.sub("#{source_filepath}/gems/#{gem_name}/", '')
-            logger.debug "dest: #{dest}"
-            if File.directory?(src)
-              logger.debug "mkdir -p #{dest}"
-              FileUtils.mkdir_p(dest)
-            else
-              unless src =~ /\/\./ # remove any pesky hidden files that crept into the archive
-                logger.debug "cp #{src} #{dest}"
-                FileUtils.cp(src, dest)
-              end
-            end
-          end
-        end
+    def basic_route_lines
+      output = <<-EOS
+
+  ### Begin RailsThemes basic generated routes ###
+  # Routes to RailsThemes Theme Example markup:
+  unless Rails.env.production?
+    get 'railsthemes', controller: :railsthemes, action: :index
+    match 'railsthemes/:action', controller: :railsthemes, via: [:get, :post]
+  end
+
+  # This is magical routing for errors (instead of using the static markup in
+  # public/*.html)
+  get '/403', to: 'railsthemes_errors#403_forbidden'
+  get '/404', to: 'railsthemes_errors#404_not_found'
+  get '/500', to: 'railsthemes_errors#500_internal_server_error'
+
+  ### End RailsThemes basic generated routes ###
+      EOS
+      output.split("\n")
+    end
+
+    def create_railsthemes_demo_routes
+      lines = Utils.lines('config/routes.rb')
+      lines_to_insert = []
+
+      if lines.grep(/Begin RailsThemes basic generated routes/).count == 0
+        lines_to_insert += basic_route_lines
       end
 
-      # this happens after a successful copy so that we set up the environment correctly
-      # for people to view the theme correctly
-      def post_copying_changes
-        logger.info "Removing public/index.html"
-        Utils.remove_file File.join('public', 'index.html')
-        create_railsthemes_demo_pages
+      if lines.grep(/^\s*root /).count == 0
+        lines_to_insert << '  root :to => "railsthemes#index"'
       end
 
-      def create_railsthemes_demo_pages
-        logger.warn 'Creating RailsThemes demo pages...'
-
-        logger.debug "mkdir -p app/controllers"
-        FileUtils.mkdir_p(File.join('app', 'controllers'))
-        logger.debug "writing to app/controllers/railsthemes_controller.rb"
-        File.open(File.join('app', 'controllers', 'railsthemes_controller.rb'), 'w') do |f|
-          f.write <<-EOS
-class RailsthemesController < ApplicationController
-  # normally every view will use your application layout
-  def inner
-    render :layout => 'application'
-  end
+      logger.warn 'Creating basic RailsThemes routes...'
+      Utils.insert_into_routes_file! lines_to_insert
+      logger.warn 'Done creating basic RailsThemes routes.'
+    end
 
-  # this is a special layout for landing and home pages
-  def landing
-    render :layout => 'landing'
-  end
-end
-          EOS
-        end
+    # General assumption is `bundler check` is always clean prior to installation (via ensurer),
+    # so if the gemspecs are in the Gemfile.lock, then the gem is in the Gemfile
+    def add_needed_gems
+      installed_gems = Utils.gemspecs.map(&:name)
+      ['sass', 'jquery-rails', 'jquery-ui-rails'].each do |gemname|
+        Utils.add_gem_to_gemfile gemname unless installed_gems.include?(gemname)
+      end
 
-        Utils.conditionally_insert_routes({
-          'railsthemes/landing' => 'railsthemes#landing',
-          'railsthemes/inner' => 'railsthemes#inner',
-          'railsthemes/jquery_ui' => 'railsthemes#jquery_ui'
-        })
+      unless installed_gems.include?('compass-rails')
+        Utils.add_gem_to_gemfile('compass-rails', :group => 'assets')
+      end
 
-        logger.warn 'Done creating RailsThemes demo pages.'
+      unless installed_gems.include?('zurb-foundation')
+        Utils.add_gem_to_gemfile('zurb-foundation', :version => '~> 4.0', :group => 'assets')
       end
+    end
+
+    def add_to_asset_precompilation_list theme_name
+      config_lines = Utils.lines('config/environments/production.rb')
+      count = config_lines.grep(/^\s*config.assets.precompile\s*\+=\s*%w\(\s*railsthemes_#{theme_name}\.js\s+railsthemes_#{theme_name}\.css\s*\)$/).count
+      if count == 0 # precompile line we want not found, add it
+        added = false # only want to add the new line once
+        Utils.safe_write('config/environments/production.rb') do |f|
+          config_lines.each do |line|
+            f.puts line
+            if !added && (line =~ /Precompile additional assets/ || line =~ /config\.assets\.precompile/)
+              f.puts "  config.assets.precompile += %w( railsthemes_#{theme_name}.js railsthemes_#{theme_name}.css )"
+              added = true
+            end
+          end
+        end
+      end
+    end
+
+    def comment_out_formtastic_if_user_does_not_use_formtastic theme_name
+      return if (Utils.gemspecs.map(&:name) & ['formtastic']).count > 0
+      filename = "app/assets/stylesheets/railsthemes_#{theme_name}.css"
+      Utils.safe_read_and_write(filename) do |lines, f|
+        lines.each do |line|
+          if line =~ /\*= require formtastic/
+            f.puts ' * require formtastic'
+          else
+            f.puts line
+          end
+        end
+      end
+    end
+
+    private
+
+    def override? dest
+      dest =~ /overrides/ && File.exists?(dest)
+    end
 
+    def system_file? src
+      File.basename(src)[0,1] == '.' # remove any pesky hidden files that crept into the archive
     end
   end
 end

data/lib/railsthemes/utils.rb

@@ -1,136 +1,177 @@
 module Railsthemes
-  class Utils < Thor
-    no_tasks do
-      extend Railsthemes::Logging
-      extend Thor::Actions
-
-      # remove file only if it exists
-      def self.remove_file filepath
-        if File.exists?(filepath)
-          File.delete filepath
-        end
-      end
+  class Utils
+    extend Railsthemes::Logging
+
+    def self.remove_file filepath
+      File.delete filepath if File.exists?(filepath)
+    end
 
-      # copy a file, ensuring that the directory is present
-      def self.copy_ensuring_directory_exists src, dest
-        FileUtils.mkdir_p(File.dirname(dest)) # create directory if necessary
-        FileUtils.cp src, dest
+    def self.safe_write filepath, &block
+      create_dir_for(filepath)
+      File.open(filepath, 'w') do |f|
+        yield f
       end
+    end
 
-      def self.read_file filepath
-        File.exists?(filepath) ? File.read(filepath) : ''
+    def self.safe_read_and_write filepath, &block
+      create_dir_for(filepath)
+      lines = read_file(filepath).split("\n")
+      File.open(filepath, 'w') do |f|
+        yield lines, f
       end
+    end
 
-      # would be nice to put download status in the output (speed, progress, etc.)
-      # needs tests
-      def self.download params = {}
-        url = params[:url]
-        save_to = params[:save_to]
-        return unless url && save_to
-        logger.info "Downloading url: #{url}"
-        logger.info "Saving to: #{save_to}"
-        uri = URI(url)
-        http = Net::HTTP.new uri.host, uri.port
-        set_https http if uri.scheme == 'https'
-        path = url.gsub(%r{https?://[^/]+}, '')
-        response = http.get(path)
-        if response.code.to_s == '200'
-          File.open(save_to, 'wb') do |file|
-            file.write(response.body)
-          end
-        else
-          logger.debug "response.code: #{response.code}"
-          logger.debug "response.body: #{response.body}"
-          Safe.log_and_abort 'Had trouble downloading a file and cannot continue.'
+    def self.create_dir_for filepath
+      FileUtils.mkdir_p(File.dirname(filepath))
+    end
+
+    def self.copy_ensuring_directory_exists src, dest
+      create_dir_for(dest)
+      logger.debug "Copying #{src} to #{dest}"
+      FileUtils.cp src, dest
+    end
+
+    def self.read_file filepath
+      File.exists?(filepath) ? File.read(filepath) : ''
+    end
+
+    def self.lines filepath
+      read_file(filepath).split("\n")
+    end
+
+    # would be nice to put download status in the output (speed, progress, etc.)
+    # needs tests
+    def self.download params = {}
+      url = params[:url]
+      save_to = params[:save_to]
+      return unless url && save_to
+      logger.info "Downloading url: #{url}"
+      logger.info "Saving to: #{save_to}"
+      uri = URI(url)
+      http = Net::HTTP.new uri.host, uri.port
+      set_https http if uri.scheme == 'https'
+      path = url.gsub(%r{https?://[^/]+}, '')
+      response = http.get(path)
+      if response.code.to_s == '200'
+        File.open(save_to, 'wb') do |file|
+          file.write(response.body)
         end
+      else
+        logger.debug "response.code: #{response.code}"
+        logger.debug "response.body: #{response.body}"
+        Safe.log_and_abort 'Had trouble downloading a file and cannot continue.'
       end
+    end
 
-      # needs tests I think
-      def self.get_url url
-        uri = URI.parse url
-        http = Net::HTTP.new uri.host, uri.port
-        set_https http if uri.scheme == 'https'
-        path = url.gsub(%r{https?://[^/]+}, '')
-        http.request_get(path)
-      end
+    # needs tests I think
+    def self.get_url url
+      uri = URI.parse url
+      http = Net::HTTP.new uri.host, uri.port
+      set_https(http) if uri.scheme == 'https'
+      path = url.gsub(%r{https?://[^/]+}, '')
+      http.request_get(path)
+    end
 
-      # needs tests
-      def self.set_https http
-        cacert_file = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'cacert.pem')
-        http.ca_file = cacert_file
-        http.ca_path = cacert_file
-        ENV['SSL_CERT_FILE'] = cacert_file
+    # needs tests
+    def self.set_https http
+      cacert_file = File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'cacert.pem')
+      http.ca_file = cacert_file
+      http.ca_path = cacert_file
+      ENV['SSL_CERT_FILE'] = cacert_file
 
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      end
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
 
-      def self.archive? filepath
-        File.exists?(filepath) && filepath =~ /\.tar\.gz$/
-      end
+    def self.archive? filepath
+      File.exists?(filepath) && filepath =~ /\.tar\.gz$/
+    end
 
-      # needs tests
-      def self.with_tempdir &block
-        tempdir = generate_tempdir_name
-        FileUtils.mkdir_p tempdir
-        yield tempdir
-        FileUtils.rm_rf tempdir
-      end
+    # needs tests
+    def self.with_tempdir &block
+      tempdir = generate_tempdir_name
+      FileUtils.mkdir_p tempdir
+      yield tempdir
+      FileUtils.rm_rf tempdir
+    end
 
-      # needs tests
-      def self.generate_tempdir_name
-        tempdir = File.join(Dir.tmpdir, DateTime.now.strftime("railsthemes-%Y%m%d-%H%M%S-#{rand(100000000)}"))
-        logger.debug "tempdir: #{tempdir}"
-        tempdir
-      end
+    # needs tests
+    def self.generate_tempdir_name
+      tempdir = File.join(Dir.tmpdir, DateTime.now.strftime("railsthemes-%Y%m%d-%H%M%S-#{rand(100000000)}"))
+      logger.debug "tempdir: #{tempdir}"
+      tempdir
+    end
 
-      # needs tests
-      def self.gemspecs gemfile_contents = nil
-        gemfile_contents ||= Utils.read_file('Gemfile.lock')
-        return [] if gemfile_contents.strip == ''
-        lockfile = Bundler::LockfileParser.new(gemfile_contents)
-        lockfile.specs
-      end
+    # needs tests
+    def self.gemspecs gemfile_contents = nil
+      gemfile_contents ||= Utils.read_file('Gemfile.lock')
+      return [] if gemfile_contents.strip == ''
+      lockfile = Bundler::LockfileParser.new(gemfile_contents)
+      lockfile.specs
+    end
+
+    def self.unarchive archive, extract_to
+      Safe.log_and_abort "Archive expected at #{archive}, but none exists." unless File.exist?(archive)
+      logger.warn "Extracting..."
+      logger.info "Attempting to extract #{archive}"
+      io = Tar.ungzip(File.open(archive, 'rb'))
+      Tar.untar(io, extract_to)
+      logger.warn "Finished extracting."
+    end
+
+    def self.get_primary_configuration gemfile_contents = read_file('Gemfile.lock')
+      gem_names = gemspecs(gemfile_contents).map(&:name)
+      [(gem_names.include?('haml') ? 'haml' : 'erb'),
+        (gem_names.include?('sass') ? 'scss' : 'css')]
+    end
 
-      def self.unarchive archive, extract_to
-        Safe.log_and_abort "Archive expected at #{archive}, but none exists." unless File.exist?(archive)
-        logger.warn "Extracting..."
-        logger.info "Attempting to extract #{archive}"
-        io = Tar.ungzip(File.open(archive, 'rb'))
-        Tar.untar(io, extract_to)
-        logger.warn "Finished extracting."
+    def self.insert_into_routes_file! to_insert
+      lines = lines('config/routes.rb')
+      last = lines.pop
+      lines += to_insert
+      lines << last
+      FileUtils.mkdir_p('config')
+      File.open(File.join('config', 'routes.rb'), 'w') do |f|
+        lines.each do |line|
+          f.puts line
+        end
       end
+    end
 
-      def self.get_primary_configuration gemfile_contents = read_file('Gemfile.lock')
-        gem_names = gemspecs(gemfile_contents).map(&:name)
-        [(gem_names.include?('haml') ? 'haml' : 'erb'),
-          (gem_names.include?('sass') ? 'scss' : 'css')]
+    def self.add_gem_to_gemfile gem_name, attributes = {}
+      File.open('Gemfile', 'a') do |f|
+        line = "gem '#{gem_name}'"
+        line += ", '#{attributes[:version]}'" if attributes[:version]
+        line += ", :group => '#{attributes[:group]}'" if attributes[:group]
+        line += " # RailsThemes"
+        f.puts line
       end
+    end
 
-      # needs tests
-      def self.conditionally_insert_routes routes_hash
-        if File.exists?(File.join('config', 'routes.rb'))
-          lines = Utils.read_file('config/routes.rb').split("\n")
-          last = lines.pop
-          routes_hash.each do |first, second|
-            if lines.grep(/#{second}/).empty?
-              lines << "  match '#{first}' => '#{second}'"
-            end
+    def self.set_layout_in_application_controller theme_name
+      ac_lines = Utils.lines('app/controllers/application_controller.rb')
+      count = ac_lines.grep(/^\s*layout 'railsthemes/).count
+      if count == 0 # layout line not found, add it
+        Utils.safe_write('app/controllers/application_controller.rb') do |f|
+          ac_lines.each do |line|
+            f.puts line
+            f.puts "  layout 'railsthemes_#{theme_name}'" if line =~ /^class ApplicationController/
           end
-          lines << last
-          File.open(File.join('config', 'routes.rb'), 'w') do |f|
-            lines.each do |line|
+        end
+      elsif count == 1 # layout line found, change it if necessary
+        Utils.safe_write('app/controllers/application_controller.rb') do |f|
+          ac_lines.each do |line|
+            if line =~ /^\s*layout 'railsthemes_/
+              f.puts "  layout 'railsthemes_#{theme_name}'"
+            else
               f.puts line
             end
           end
         end
-      end
-
-      def self.add_gem_to_gemfile gem_name
-        File.open('Gemfile', 'a') do |f|
-          f.puts "gem '#{gem_name}'"
-        end
+      else
+        # multiple layout lines, not sure what to do here
       end
     end
+
   end
 end

data/lib/railsthemes/version.rb

@@ -1,5 +1,5 @@
 module Railsthemes
   unless defined?(Railsthemes::VERSION)
-    VERSION = "1.2.0"
+    VERSION = "2.0.0.pre"
   end
 end

data/lib/railsthemes.rb

@@ -15,16 +15,9 @@ require 'railsthemes/tar'
 require 'railsthemes/installer'
 require 'railsthemes/theme_installer'
 require 'railsthemes/email_installer'
-require 'railsthemes/asset_installer'
 require 'railsthemes/ensurer'
+require 'railsthemes/os'
+require 'railsthemes/switcher'
 
 module Railsthemes
-  def self.server
-    @server ||= 'https://railsthemes.com'
-  end
-
-  def self.server= server
-    Logging.logger.warn "Using server: #{server}"
-    @server = server
-  end
 end