retter 0.2.5 → 1.0.0.pre

data/Rakefile

@@ -1,8 +1,28 @@
-require 'bundler'
-
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
+require 'fileutils'
+require 'pathname'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+require 'tmpdir'
+require 'retter'
+
+RSpec::Core::RakeTask.new :spec
+
+task :test_pkg => :build do
+  begin
+    pkg_path  = File.join(File.dirname(__FILE__), 'pkg', "retter-#{Retter::VERSION}.gem")
+    build_dir = Dir.mktmpdir
+
+    sh %(gem install #{pkg_path} -i #{build_dir} --no-document)
+
+    Bundler.with_clean_env do
+      ENV['GEM_HOME_WITH_RETTER'] = build_dir
 
-task default: :spec
+      Rake::Task['spec'].execute
+    end
+  ensure
+    FileUtils.remove_entry_secure build_dir
+  end
+end
 
+task :default => [:spec]
+task :all     => [:spec, :test_pkg]

data/bin/retter

@@ -1,26 +1,6 @@
 #!/usr/bin/env ruby
-# coding: utf-8
-
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-
-trap :INT do
-  print "\r"
-  exit
-end
 
 require 'retter'
 
-Retter::Site.load ENV
-
-case ARGV[0]
-when 'new'
-  Retter::Generator::Creator.start ARGV[1..-1]
-else
-  begin
-    Retter::Command.start
-  rescue Errno::ENOENT
-    $stderr.puts "Some files might be broken. Please re-generate site: `retter new site-name`"
-
-    raise
-  end
-end
+Retter.initialize!
+Retter::CLI.start

data/lib/retter.rb

@@ -1,62 +1,76 @@
-# coding: utf-8
-
-here = File.dirname(__FILE__)
-$LOAD_PATH.unshift here unless $LOAD_PATH.include?(here)
-
-require 'date'
-require 'time'
-require 'pathname'
-require 'active_support/time_with_zone' # XXX: workaround for uninitialized constant ActiveSupport::TimeWithZone (NameError)
+require 'active_support/concern'
+require 'active_support/core_ext'
+require 'active_support/ordered_options'
+require 'retter/version'
 
 module Retter
-  autoload :Generator,    'retter/generator'
-  autoload :VERSION,      'retter/version'
-  autoload :Configurable, 'retter/configurable'
-  autoload :Config,       'retter/config'
-  autoload :Markdown,     'retter/markdown'
+  autoload :CLI,          'retter/cli'
+  autoload :Deprecated,   'retter/deprecated'
   autoload :Entry,        'retter/entry'
-  autoload :Entries,      'retter/entries'
-  autoload :Page,         'retter/page'
-  autoload :Binder,       'retter/binder'
-  autoload :Preprint,     'retter/preprint'
+  autoload :Initializing, 'retter/initializing'
   autoload :Repository,   'retter/repository'
-  autoload :Command,      'retter/command'
+  autoload :Retterfile,   'retter/retterfile'
+  autoload :StaticSite,   'retter/static_site'
 
-  class RetterError < RuntimeError; end
+  include Initializing
+  include Deprecated::Retter
+  include Deprecated::Site
 
-  module Site
-    extend self
-    extend Configurable
+  API_REVISION = 1
 
-    configurable :home, :title, :description, :url, :author
+  class << self
+    def config
+      @config ||= ActiveSupport::OrderedOptions.new
+    end
 
-    def load(env)
-      @@config = Config.new(env)
+    def root; config.root end
+
+    def retterfile
+      Retterfile.instance
     end
 
-    def reset!
-      @@entries = nil
+    def initialize!
+      @config = nil
+
+      load_defaults
+      retterfile.seek_load
+
+      install_site_module
+      warn_missing_api_revision
+
+      process_initialize
     end
 
-    def entries
-      @@entries ||= Entries.new
+    private
+
+    def env
+      ENV
     end
 
-    def config
-      @@config
+    def install_site_module
+      return unless mod = config.site_type
+
+      mod.install
     end
-  end
 
-  class << self
-    def const_missing(name)
-      case name.intern
-      when :Renderers
-        warn %(Retter::Renderers is OBSOLETE, Use Retter::Markdown.)
-
-        Markdown
-      else
-        super
-      end
+    def load_defaults
+      config.api_revision ||= 0
+      config.editor       ||= env['EDITOR']
+      config.shell        ||= env['SHELL']
+      config.url          ||= 'http://example.com'
+      config.site_type    ||= Retter::StaticSite
+    end
+
+    def warn_missing_api_revision
+      return if config.api_revision == API_REVISION
+      return unless root
+
+      warn <<-MESSAGE.strip_heredoc
+        *** WARNING ***
+        Reading site (#{root.basename}) isn't compatible with current retter version (#{VERSION}).
+        Please run `retter migrate` or `gem uninstall retter -v #{VERSION}`.
+        For more information, see https://github.com/hibariya/retter#migrate-from-retter-025-or-earlier
+      MESSAGE
     end
   end
 end

data/lib/retter/cli.rb

@@ -0,0 +1,46 @@
+require 'thor'
+
+module Retter
+  module CLI
+    autoload :Edit,    'retter/cli/edit'
+    autoload :Hooks,   'retter/cli/hooks'
+    autoload :List,    'retter/cli/list'
+    autoload :New,     'retter/cli/new'
+    autoload :Preview, 'retter/cli/preview'
+    autoload :Publish, 'retter/cli/publish'
+
+    class Command < Thor
+      include Thor::Actions
+      include Deprecated::CLI::Command
+
+      register Edit,    'edit',    'edit [KEYOWRD]', 'Open an entry with $EDITOR'
+      register List,    'list',    'list',           'List all entries'
+      register New,     'new',     'new NAME',       'Create a new site'
+      register Preview, 'preview', 'preview',        'Preview on browser'
+      register Publish, 'publish', 'publish',        'Run publish proc on $RETTER_ROOT'
+
+      default_task :edit
+
+      map '--version' => :version, '-v' => :version
+
+      desc :version, 'Show version'
+      def version
+        puts VERSION
+      end
+
+      no_tasks do
+        def invoke(klass_or_name, *)
+          super
+
+          klass_or_name.call_hooks :after, self if klass_or_name.respond_to?(:call_hooks)
+        end
+      end
+    end
+
+    class << self
+      def start(*args)
+        Command.start *args
+      end
+    end
+  end
+end

data/lib/retter/cli/edit.rb

@@ -0,0 +1,33 @@
+module Retter
+  class CLI::Edit < Thor::Group
+    class_attribute :editor
+
+    include CLI::Hooks
+
+    argument :keyword, type: :string, required: false, desc: 'The keyword for an entry'
+
+    def edit
+      path = Entry.generate_entry_path(keyword)
+
+      invoke_editor editor, path
+    end
+
+    private
+
+    def invoke_editor(editor, path)
+      invoke_proc = -> { system editor, path.to_s }
+
+      if Object.const_defined?(:Bundler)
+        Bundler.with_clean_env do
+          invoke_proc.call
+        end
+      else
+        invoke_proc.call
+      end
+    end
+
+    Retter.on_initialize do |config|
+      self.editor = config.editor
+    end
+  end
+end

data/lib/retter/cli/hooks.rb

@@ -0,0 +1,46 @@
+require 'set'
+
+module Retter
+  module CLI
+    module Hooks
+      extend ActiveSupport::Concern
+
+      included do
+        include Thor::Actions
+      end
+
+      module ClassMethods
+        mattr_accessor :callbacks
+
+        def hookable_name(*names)
+          names.each do |name|
+            hookable_names << name
+          end
+        end
+
+        def hookable_names
+          @hookable_names ||= Set.new([name.demodulize.underscore.intern])
+        end
+
+        def call_hooks(hook_point = :after, context = CLI::Command.new)
+          return unless callbacks
+
+          hookable_names.each do |name|
+            case callback = callbacks["#{hook_point}_#{name}".intern]
+            when Proc
+              context.instance_eval &callback
+            when Symbol, String
+              context.invoke callback
+            else
+              # noop
+            end
+          end
+        end
+
+        Retter.on_initialize do |config|
+          self.callbacks = config.callbacks
+        end
+      end
+    end
+  end
+end

data/lib/retter/cli/list.rb

@@ -0,0 +1,15 @@
+module Retter
+  class CLI::List < Thor::Group
+    include CLI::Hooks
+
+    def list
+      Entry.all.each.with_index do |entry, index|
+        puts %([e#{index}] #{entry.date})
+
+        entry.articles.each do |article|
+          puts %(  #{article.title})
+        end
+      end
+    end
+  end
+end

data/lib/retter/cli/new.rb

@@ -0,0 +1,20 @@
+module Retter
+  class CLI::New < Thor::Group
+    include Thor::Actions
+
+    argument :name, type: :string, required: true, desc: 'Site name'
+    class_option :minimum, default: false, type: :boolean, desc: 'Install minimum files only'
+
+    def self.source_paths
+      [File.expand_path('../../../../skel', __FILE__)]
+    end
+
+    def instal_minimum
+      FileUtils.mkdir_p name
+
+      template 'Retterfile', %(#{name}/Retterfile)
+
+      exit if options[:minimum]
+    end
+  end
+end

data/lib/retter/cli/preview.rb

@@ -0,0 +1,9 @@
+module Retter
+  class CLI::Preview < Thor::Group
+    include CLI::Hooks
+
+    def preview
+      # nothing to do
+    end
+  end
+end

data/lib/retter/cli/publish.rb

@@ -0,0 +1,22 @@
+module Retter
+  class CLI::Publish < Thor::Group
+    class_attribute :root_path, :publish_proc
+
+    include CLI::Hooks
+
+    def publish
+      return unless publish_proc
+
+      Dir.chdir root_path do
+        instance_eval &publish_proc
+      end
+    end
+
+    Retter.on_initialize do |config|
+      self.root_path    = config.root
+      self.publish_proc = config.publisher
+
+      -> { }
+    end
+  end
+end

data/lib/retter/deprecated.rb

@@ -0,0 +1,160 @@
+require 'set'
+
+module Retter
+  module Deprecated
+    class << self
+      def removed_warn(name, alternate = nil, location = caller[1])
+        warn_once build_warn(name, 'removed', alternate, location)
+      end
+
+      def warn(name, alternate = nil, location = caller[1])
+        warn_once build_warn(name, 'deprecated', alternate, location)
+      end
+
+      private
+
+      def build_warn(name, cause, alternate, location)
+        message =  "WARNING: #{location} `#{name}' is #{cause}."
+        message << " Please use `#{alternate}' instead of `#{name}'." if alternate
+
+        message
+      end
+
+      def warn_once(message)
+        return if shown.include?(message)
+
+        Kernel.warn message
+        shown << message
+
+        nil
+      end
+
+      def shown
+        @shown ||= Set.new
+      end
+    end
+
+    module Retter
+      extend ActiveSupport::Concern
+
+      DEPRECATED_CONSTANTS = {
+        Markdown: 'Retter::StaticSite::Markdown'
+      }
+
+      module ClassMethods
+        def const_missing(name)
+          return super unless DEPRECATED_CONSTANTS.keys.include?(name)
+
+          right_name = DEPRECATED_CONSTANTS[name]
+          Deprecated.warn "Retter::#{name}", right_name
+
+          right_name.constantize
+        end
+      end
+    end
+
+    module Site
+      extend ActiveSupport::Concern
+
+      included do
+        module Site
+          extend self
+
+          %w(home title description url author load reset! entries config).each do |name|
+            define_method name do |*args|
+              Deprecated.removed_warn %(Retter::Site##{name})
+            end
+          end
+        end
+      end
+    end
+
+    module Entry
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method :path, :source_path
+      end
+
+      module Article
+        def to_s
+          Deprecated.warn 'Retter::Entry::Article#to_s', 'Retter::Entry::Article#body (And you may want to call .html_safe)'
+          body.html_safe
+        end
+
+        def actual?
+          Deprecated.removed_warn 'Retter::Entry::Article#actual?'
+          true
+        end
+      end
+    end
+
+    module CLI
+      module Build
+        extend ActiveSupport::Concern
+
+        included do
+          hookable_name :bind, :rebind, :commit
+        end
+      end
+
+      module Command
+        extend ActiveSupport::Concern
+
+        included do
+          desc :rebind, '[DEPRECATED]', hide: true
+          method_options silent: :boolean
+          def rebind
+            Deprecated.warn :rebind, :build, '(command)'
+
+            invoke :build
+          end
+
+          desc :bind, '[DEPRECATED]', hide: true
+          method_options silent: :boolean
+          def bind
+            Deprecated.warn :bind, :build, '(command)'
+
+            invoke :build
+          end
+
+          desc :commit, '[DEPRECATED]', hide: true
+          method_options silent: :boolean
+          def commit
+            Deprecated.removed_warn :commit, :build, '(command)'
+          end
+
+          desc :home, '[DEPRECATED]', hide: true
+          def home
+            Deprecated.removed_warn :home, nil, '(command)'
+          end
+
+          desc :usage, '[DEPRECATED]', hide: true
+          def usage(*args)
+            Deprecated.removed_warn :usage, :help, '(command)'
+          end
+
+          desc :open, '[DEPRECATED]', hide: true
+          def open(*args)
+            Deprecated.removed_warn :open, :preview, '(command)'
+          end
+
+          desc :clean, '[DEPRECATED]', hide: true
+          def clean(*args)
+            Deprecated.removed_warn :clean, nil, '(command)'
+          end
+        end
+      end
+    end
+
+    module Retterfile
+      module Context
+        %w(markup cache allow_binding home retter_home layouts_dir entries_dir retters_dir wip_file).each do |name|
+          define_method name do |val = nil|
+            Deprecated.removed_warn name, nil, 'Retterfile'
+          end
+        end
+      end
+    end
+  end
+end