under_construction 0.0.1

data/app/models/under_construction_email_storage.rb

@@ -0,0 +1,61 @@
+class UnderConstructionEmailStorage
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+  extend ActiveModel::Naming
+
+  attr_accessor :email
+  FILE_PATH = Rails.root + "db/under_construction_mails.txt"
+
+    class UniquenessValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        emails_path = Rails.root + "db/under_construction_mails.txt"
+        if File.exist? emails_path
+          File.open(emails_path, "r") do |f|
+            if f.readlines.include? value + "\n"
+              record.errors[attribute] << I18n.t('activemodel.errors.models.under_construction_email_storage.attributes.email.uniqueness', default: "Already submitted")
+            end
+          end
+        end
+      end
+    end
+
+  validates :email, presence: true, uniqueness: true,
+            format: { with: /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i,
+                      message: I18n.t('activemodel.errors.models.under_construction_email_storage.attributes.email.format', default: "doesn't looks like correct") }
+
+  def initialize(attributes = {})
+    attributes.each do |name, value|
+      send("#{name}=", value)
+    end
+  end
+
+  def persisted?
+    false
+  end
+
+  # save submitted mail to a text file
+  def save_to_file
+    File.open(FILE_PATH, "a") do |f|
+      f.puts email
+    end
+  end
+
+  # return emails in a array
+  def self.emails
+    File.open(FILE_PATH, "r") do |f|
+      f.readlines
+    end
+  rescue Errno::ENOENT
+    []
+  end
+
+  def self.no_emails?
+    emails.empty?
+  end
+
+  def self.remove_file
+    if File.exist? FILE_PATH
+      FileUtils.rm FILE_PATH
+    end
+  end
+end

data/app/views/email_storage/_form.html.erb

@@ -0,0 +1,6 @@
+<%= form_for @email, url: under_construction_email_storage_index_path, html: { id: 'subscribeform' } do |f| %>
+  <div id='email_input'>
+    <%= f.text_field :email, id: 'email', placeholder: @info['email_field_value'], size: 30 %>
+    <%= f.submit t('.submit', default: "SUBMIT"), id: 'submit' %>
+  </div>
+<% end %>

data/app/views/notify_under_construction_submitted_mails/under_construction_notify.text.erb

@@ -0,0 +1 @@
+<%= UnderConstruction.config.notify_mail["email_content"] %>

data/lib/generators/under_construction/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate under_construction Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/under_construction/clear_generator.rb

@@ -0,0 +1,38 @@
+require_relative 'constants'
+
+module UnderConstruction
+  module Generators
+    class ClearGenerator < ::Rails::Generators::Base
+      desc 'Clears configs application controller'
+      def clear_application_controller
+        if File.exist?('app/controllers/application_controller.rb')
+          # remove the exact block we've inserted. We don't want
+          # to remove the block if user has edited it
+          gsub_file 'app/controllers/application_controller.rb', /#{Regexp.escape(APPLICATION_CONFIG_TXT)}/,
+            ''
+        end
+      end
+
+      def clear_routes_file
+        file_path = 'config/routes.rb'
+        gsub_file file_path, /#{Regexp.escape(ROUTES_CONFIG_TXT)}/, ''
+        gsub_file file_path, /#{Regexp.escape(ROUTES_REDIRECT_TO_TXT)}/, ''
+        insert_into_file file_path, ROUTES_CLEAR_TXT, after: /Application.routes.draw do/
+      end
+
+#      def remove_view_files
+#        file_path = 'app/views/under_construction'
+#        if File.exist? file_path
+#          remove_file file_path
+#        end
+#      end
+
+      def remove_scheduler_file
+        file_path = 'config/initializers/under_construction_scheduler.rb'
+        if File.exist? file_path
+          remove_file file_path
+        end
+      end
+    end
+  end
+end

data/lib/generators/under_construction/config_generator.rb

@@ -0,0 +1,38 @@
+require_relative 'constants'
+
+module UnderConstruction
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc 'Configs application controller'
+      def edit_application_Controller
+        if File.exist?(Rails.root + "app/controllers/application_controller.rb")
+          insert_into_file "app/controllers/application_controller.rb", APPLICATION_CONFIG_TXT, :after => "protect_from_forgery"
+        else
+          raise 'Couldn\'t find application_controller file'
+        end
+      end
+
+      def copy_config_file
+        copy_file 'under_construction.yml', 'config/under_construction.yml'
+      end
+
+      def config_route_file
+        file_path = 'config/routes.rb'
+        gsub_file file_path, /match "under_construction", :to => redirect\('\/'\)/, ''
+        insert_into_file file_path, ROUTES_CONFIG_TXT, after: /Application.routes.draw do/
+        gsub_file file_path, /(Application.routes.draw do)(.*)(end)/m, '\1\2'+"#{ROUTES_REDIRECT_TO_TXT}" + '\3'
+      end
+
+      def copy_index_file_to_app
+        directory 'under_construction', 'app/views/under_construction'
+      end
+
+      def copy_scheduler_initializer
+        destination_path = 'config/initializers/under_construction_scheduler.rb'
+        copy_file 'under_construction_scheduler.rb', destination_path
+      end
+    end
+  end
+end

data/lib/generators/under_construction/constants.rb

@@ -0,0 +1,37 @@
+module UnderConstruction
+  module Generators
+    APPLICATION_CONFIG_TXT = <<-EOM
+
+  # Editing UnderConstruction block causes it's clear generator to not work
+  before_filter :redirect_to_under_construction
+
+  # Will redirect all requests to under construction page
+  def redirect_to_under_construction
+    if request.host_with_port == UnderConstruction.config.host_name && Rails.env.production?
+      unless request.url =~ /(under_construction|email_storage)/
+        redirect_to under_construction_index_path
+      end
+    end
+  end
+  EOM
+
+    ROUTES_CONFIG_TXT = <<-EOM
+
+  # generated by under_construction gem
+  resources 'under_construction_email_storage', only: :create
+  resources 'under_construction', only: :index
+  EOM
+
+    ROUTES_REDIRECT_TO_TXT = <<-EOM
+
+  # generated by under_construction gem
+  match "/*other" => redirect("/under_construction")
+  EOM
+
+    ROUTES_CLEAR_TXT = <<-EOM
+
+  # generated by under_construction gem
+  match "under_construction", :to => redirect('/')
+  EOM
+  end
+end

data/lib/generators/under_construction/templates/under_construction/site-under-construction/index.html.erb

@@ -0,0 +1,116 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta name="generator" content=
+  "HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+  <meta http-equiv="refresh" content="60">
+
+  <title><%= @info['site_title'] %></title>
+  <%= javascript_include_tag "application" %>
+  <%= stylesheet_link_tag "under_construction/#{@theme}/style.css", :media => "all" %>
+  <%= javascript_include_tag "under_construction/#{@theme}/jquery.countdown.min.js" %>
+  <%= javascript_include_tag "under_construction/#{@theme}/jcarousellite1.0.1_min.js" %>
+  <!-- jquery countdown-->
+
+  <script type="text/javascript">
+  $(function () {
+  var austDay = new Date("<%= Chronic.parse(@launch_time).to_s(:rfc822) %>");
+    $('#defaultCountdown').countdown({until: austDay, layout: '{dn} {dl}, {hn} {hl}, {mn} {ml}, and {sn} {sl}'});
+    $('#year').text(austDay.getFullYear());
+    });
+  </script><!-- jquery slider -->
+
+  <script type="text/javascript">
+  $(function() {
+    $("#slidertext").jCarouselLite({
+        btnNext: ".next",
+        btnPrev: ".prev"
+    });
+  });
+  </script><!--script for IE6-image transparency recover-->
+  <!--[if IE 6]>
+<script type="text/javascript" src="js/DD_belatedPNG_0.0.7a-min.js"></script>
+<script>
+  /* EXAMPLE */
+  DD_belatedPNG.fix('#logo img,#main,.counter,.twitter,.flickr,.facebook,.youtube,.skype,.stumbleupon, #submit,.prev img,.next img,#email');
+</script>
+<![endif]-->
+</head>
+
+<body>
+  <div class="container">
+    <%= view_flash_messages unless view_flash_messages.blank?  %>
+    <div id="header">
+      <div id="logo">
+        <a href="/under_construction">
+          <img src="<%= @info['logo_url'] %>"></img>
+        </a>
+      </div><!--end logo-->
+
+      <div id="contact_details">
+        <p><%= link_to @info['email'], "#" %></p>
+
+        <p><%= link_to "#{@info['phone']}", "#" %></p>
+      </div><!--end contact details-->
+    </div><!--end header-->
+
+    <div style="clear:both"></div>
+
+    <div id="main">
+      <div id="content">
+        <div class="text">
+          <h2><%= @info['heading'] %></h2>
+        </div><!--end text-->
+
+        <div class="counter">
+          <h3><%= @info['counter_heading'] %></h3>
+
+          <div id="defaultCountdown"></div>
+        </div><!--end counter-->
+
+        <div class="details">
+          <!--slider prev button-->
+          <a class="prev" href="#">
+            <%= image_tag "under_construction/#{@theme}/prev.png" %></a>
+
+          <div id="sliderwrap">
+            <div id="slidertext">
+              <!-- The slider -->
+
+              <ul>
+                <li>
+                  <h3><%= @info['inform_by_email'] %></h3>
+                  <%= render partial: 'email_storage/form', object: @email %>
+                </li><!-- Slider item -->
+
+                <li>
+                  <h3><%= @socials_title %></h3>
+
+                  <div class="social">
+                    <% @socials.each do |name, url| %>
+                      <%= link_to name, url, class: name %>
+                    <% end %>
+                  </div>
+                </li><!-- Slider item -->
+
+                <li>
+                  <h3><%= @info['about_title'] %></h3>
+
+                  <p><%= @info['about_content'] %></p>
+                </li><!-- Slider item -->
+              </ul>
+            </div><!-- End of slidertext -->
+          </div><!-- End of sliderwrap -->
+          <!--slider next button-->
+          <a class="next" href=
+          "#"><%= image_tag "under_construction/#{@theme}/next.png" %></a>
+        </div><!--end details-->
+      </div><!--end content-->
+
+      <p class="copyright">
+      <%= raw @info['copyright'] + " " + @site_developer['name'] %></p>
+    </div><!--end main-->
+  </div><!--end class container-->
+</body>
+</html>

data/lib/generators/under_construction/templates/under_construction/site-under-construction-fa/index.html.erb

@@ -0,0 +1,116 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="refresh" content="60">
+  <meta name="generator" content=
+  "HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+  <title><%= @info['site_title'] %></title>
+  <%= javascript_include_tag "application" %>
+  <%= stylesheet_link_tag "under_construction/#{@theme}/style.css", :media => "all" %>
+  <%= javascript_include_tag "under_construction/#{@theme}/jquery.countdown.min.js" %>
+  <%= javascript_include_tag "under_construction/#{@theme}/jquery.countdown-fa.js" %>
+  <%= javascript_include_tag "under_construction/#{@theme}/jcarousellite1.0.1_min.js" %>
+  <!-- jquery countdown-->
+
+  <script type="text/javascript">
+  $(function () {
+  var austDay = new Date("<%= Chronic.parse(@launch_time).to_s(:rfc822) %>");
+    $('#defaultCountdown').countdown({until: austDay, layout: '{dn} {dl} و {hn} {hl} و {mn} {ml} و {sn} {sl}'});
+    $('#year').text(austDay.getFullYear());
+    });
+  </script><!-- jquery slider -->
+
+  <script type="text/javascript">
+  $(function() {
+    $("#slidertext").jCarouselLite({
+        btnNext: ".next",
+        btnPrev: ".prev"
+    });
+  });
+  </script><!--script for IE6-image transparency recover-->
+  <!--[if IE 6]>
+<script type="text/javascript" src="js/DD_belatedPNG_0.0.7a-min.js"></script>
+<script>
+  /* EXAMPLE */
+  DD_belatedPNG.fix('#logo img,#main,.counter,.twitter,.flickr,.facebook,.youtube,.skype,.stumbleupon, #submit,.prev img,.next img,#email');
+</script>
+<![endif]-->
+</head>
+
+<body dir="rtl">
+  <div class="container">
+    <%= view_flash_messages unless view_flash_messages.blank?  %>
+    <div id="header">
+      <div id="logo">
+        <a href="/under_construction">
+          <img src="<%= @info['logo_url'] %>"></img>
+        </a>
+      </div><!--end logo-->
+
+      <div id="contact_details">
+        <p><%= link_to @info['email'], "#" %></p>
+
+        <p><%= link_to "#{@info['phone']}", "#" %></p>
+      </div><!--end contact details-->
+    </div><!--end header-->
+
+    <div style="clear:both"></div>
+
+    <div id="main">
+      <div id="content">
+        <div class="text">
+          <h2><%= @info['heading'] %></h2>
+        </div><!--end text-->
+
+        <div class="counter">
+          <h3><%= @info['counter_heading'] %></h3>
+
+          <div id="defaultCountdown"></div>
+        </div><!--end counter-->
+
+        <div class="details">
+          <!--slider prev button-->
+          <a class="prev" href="#">
+            <%= image_tag "under_construction/#{@theme}/prev.png" %></a>
+
+          <div id="sliderwrap">
+            <div id="slidertext">
+              <!-- The slider -->
+
+              <ul>
+                <li>
+                  <h3><%= @info['inform_by_email'] %></h3>
+                  <%= render partial: 'email_storage/form', object: @email %>
+                </li><!-- Slider item -->
+
+                <li>
+                  <h3><%= @socials_title %></h3>
+
+                  <div class="social">
+                    <% @socials.each do |name, url| %>
+                      <%= link_to name, url, class: name %>
+                    <% end %>
+                  </div>
+                </li><!-- Slider item -->
+
+                <li>
+                  <h3><%= @info['about_title'] %></h3>
+
+                  <p><%= @info['about_content'] %></p>
+                </li><!-- Slider item -->
+              </ul>
+            </div><!-- End of slidertext -->
+          </div><!-- End of sliderwrap -->
+          <!--slider next button-->
+          <a class="next" href=
+          "#"><%= image_tag "under_construction/#{@theme}/next.png" %></a>
+        </div><!--end details-->
+      </div><!--end content-->
+
+      <p class="copyright">
+      <%= raw @info['copyright'] + " " + @site_developer['name'] %></p>
+    </div><!--end main-->
+  </div><!--end class container-->
+</body>
+</html>

data/lib/generators/under_construction/templates/under_construction.yml

@@ -0,0 +1,41 @@
+theme: 'site-under-construction'
+launch_time: "24 Feb 2050 7:00pm"
+progress: "60" # Percent
+progress_label: "Progress"
+website_address: "http://example.com"
+host_name: "localhost:3000"
+info:
+  site_title: "My Website"
+  logo_url: "/assets/under_construction/site-under-construction/logo.png"
+  email: "support@example.com"
+  phone: "phone : 555-123456"
+  heading: "This website is under construction"
+  counter_heading: "Estimated Time Remaining Before Launch:"
+  about_title: "Some words about us"
+  about_content: |
+                  Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+                  Phasellus hendrerit. Pellentesque aliquet nibh nec urna. I
+                  n nisi neque, aliquet vel, dapibus id, mattis vel, nisi.
+  inform_by_email: "Type your email id to get the updates!"
+  email_field_value: "Enter Your E-mail"
+  copyright: "Copyright ©"
+site_developer:
+  name: "Great Developer"
+socials_title: "You may find us below:"
+socials:
+  twitter: "#" #Full URL: http://twitter.com/great_developer
+  facebook: "#"
+  yahoo: "#"
+  # stumbleupon: "#"
+  flickr: "#"
+  #google: "#"
+  youtube: "#"
+  skype: "#"
+  deviantart: "#"
+  identica: "#"
+notify_mail:
+  sender_email_address: "do_not_reply@example.com"
+  email_subject: "My Website just launched!"
+  email_content: |
+                  Hi! Our site, "Example", has just launched!
+                  Click the flowing link to view the website: http://example.com

data/lib/generators/under_construction/templates/under_construction_scheduler.rb

@@ -0,0 +1,6 @@
+# This line will initialize a scheduler to remove 
+# under_construction configs after running your server
+
+Rails.application.config.after_initialize do
+  UnderConstruction::Schedule.new
+end

data/lib/tasks/under_cunstruction_tasks.rake

@@ -0,0 +1,12 @@
+desc "Send notify emails to users submited their email to underconstruction page"
+namespace :under_construction do
+  task :send_mails => :environment do
+    if File.exist? Rails.root + "db/under_construction_mails.txt"
+      UnderConstructionEmailStorage.emails.each do |email|
+        NotifyUnderConstructionSubmittedMails.under_construction_notify(email.chomp).deliver
+      end
+    else
+      puts "There's no email submitted"
+    end
+  end
+end

data/lib/under_construction/config.rb

@@ -0,0 +1,46 @@
+require 'active_support/configurable'
+require 'yaml'
+
+module UnderConstruction
+  def self.configure(&block)
+    yield @config ||= UnderConstruction::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.config_file
+    config_path = File.join(Rails.root, 'config','under_construction.yml')
+    if File.exist? File.join(Rails.root, 'config','under_construction.yml')
+      YAML.load_file(config_path)
+    else
+      false
+    end
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :theme
+    config_accessor :launch_time
+    config_accessor :host_name
+    config_accessor :progress
+    config_accessor :progress_label
+    config_accessor :info
+    config_accessor :site_developer
+    config_accessor :socials_title
+    config_accessor :socials
+    config_accessor :notify_mail
+    config_accessor :website_address
+  end
+
+  if config_file
+    configure do |configuration|
+      config_file.each_pair do |key, value|
+        configuration.config[key.to_sym] = value
+      end
+    end
+  end
+
+end

data/lib/under_construction/engine.rb

@@ -0,0 +1,15 @@
+module UnderConstruction
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec,
+        :fixtures => false,
+        :view_specs => false,
+        :helper_specs => false,
+        :routing_specs => false,
+        :controller_specs => true,
+        :request_specs => true
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/under_construction/schedule.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+
+module UnderConstruction
+  class Schedule
+    def initialize(*args)
+      @scheduler  = Rufus::Scheduler.start_new
+      @end_time   = args[0]
+      schedule()
+    end
+
+    def schedule
+      @end_time ||= UnderConstruction.config.launch_time
+      @job = @scheduler.at Chronic.parse(@end_time) do
+        invoke_clear_generator()
+      end
+    end
+
+    # Stop the schedule
+    def stop_schedule
+      @job.unschedule
+    end
+
+    # Shows all schaduled jobs. just for testing perposes
+    def jobs
+      @scheduler.jobs
+    end
+
+  private
+    def invoke_clear_generator
+      Rails::Generators.invoke('under_construction:clear')
+      # If there's a scheduled job, remove it
+      stop_schedule if jobs.size > 0
+      # To make passenger to restart the application
+      FileUtils.touch Rails.root + 'tmp/restart.txt'
+      # After restart server, sends email to subscribers
+      system "bundle exec rake under_construction:send_mails RAILS_ENV=#{Rails.env}"
+    end
+  end
+end

data/lib/under_construction/version.rb

@@ -0,0 +1,3 @@
+module UnderConstruction
+  VERSION = "0.0.1"
+end

data/lib/under_construction.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'rufus-scheduler'
+require 'chronic'
+
+require "under_construction/engine"
+
+module UnderConstruction
+
+  class Railtie < ::Rails::Railtie
+    initializer "set_autoload_paths" do |app|
+      if app.config.autoload_paths
+        require "under_construction/config"
+        require "under_construction/schedule"
+      end
+    end
+  end
+
+end