Merge branch 'master' into web-merge

Author: onur

README.md

@@ -1,11 +1,10 @@
 
-# cratesfyi
+# docs.rs
 
-[![Build Status](https://secure.travis-ci.org/onur/cratesfyi.svg?branch=master)](https://travis-ci.org/onur/cratesfyi)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/onur/cratesfyi/master/LICENSE)
+[![Build Status](https://secure.travis-ci.org/onur/docs.rs.svg?branch=master)](https://travis-ci.org/onur/docs.rs)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/onur/docs.rs/master/LICENSE)
 
-Centralized crate documentation builder and explorer for the Rust programming
-language.
+Documentation host for the Rust Programming Language crates.
 
 
 ## Installation
@@ -111,7 +110,7 @@ yourusername	ALL=(ALL) NOPASSWD: /usr/sbin/chroot
 ```
 
 
-### Seting up database
+### Setting up database
 
 cratesfyi is using postgresql database to store crate and build
 information. You need to set up database before using chroot builder. To do

src/bin/cratesfyi.rs

@@ -89,7 +89,9 @@ pub fn main() {
                                                       .arg(Arg::with_name("CRATE_VERSION")
                                                                .index(2)
                                                                .required(true)
-                                                               .help("Version of crate"))))
+                                                               .help("Version of crate")))
+                                      .subcommand(SubCommand::with_name("add-essential-files")
+                                                      .about("Adds essential files for rustc")))
                       .subcommand(SubCommand::with_name("start-web-server")
                                       .about("Starts web server")
                                       .arg(Arg::with_name("SOCKET_ADDR")
@@ -175,6 +177,8 @@ pub fn main() {
             docbuilder.build_package(matches.value_of("CRATE_NAME").unwrap(),
                                      matches.value_of("CRATE_VERSION").unwrap())
                       .expect("Building documentation failed");
+        } else if let Some(_) = matches.subcommand_matches("add-essential-files") {
+            docbuilder.add_essential_files().expect("Failed to add essential files");
         }
 
         docbuilder.save_cache().expect("Failed to save cache");

src/db/add_package.rs

@@ -88,7 +88,7 @@ pub fn add_package_into_database(conn: &Connection,
                              $8, test_status = $9, license = $10, repository_url = $11, \
                              homepage_url = $12, description = $13, description_long = $14, \
                              readme = $15, authors = $16, keywords = $17, have_examples = $18, \
-                             downloads = $19, files = $20, doc_targets = $21, is_library = $22 \
+                             downloads = $19, files = $20, doc_targets = $21, is_library = $22, \
                              doc_rustc_version = $23 \
                              WHERE crate_id = $1 AND version = $2",
                             &[&crate_id,
@@ -112,6 +112,7 @@ pub fn add_package_into_database(conn: &Connection,
                               &downloads,
                               &files,
                               &doc_targets.to_json(),
+                              &is_library,
                               &res.rustc_version]));
             rows.get(0).get(0)
         }

src/docbuilder/chroot_builder.rs

@@ -331,6 +331,100 @@ impl DocBuilder {
                           package.manifest().version()));
         add_path_into_database(conn, &prefix, crate_doc_path)
     }
+
+
+    /// This function will build an empty crate and will add essential documentation files.
+    ///
+    /// It is required to run after every rustc update. cratesfyi is not keeping this files
+    /// for every crate to avoid duplications.
+    ///
+    /// List of the files:
+    ///
+    /// * rustdoc.css (with rustc version)
+    /// * main.css (with rustc version)
+    /// * main.js (with rustc version)
+    /// * jquery.js (with rustc version)
+    /// * playpen.js (with rustc version)
+    /// * normalize.css
+    /// * FiraSans-Medium.woff
+    /// * FiraSans-Regular.woff
+    /// * Heuristica-Italic.woff
+    /// * SourceCodePro-Regular.woff
+    /// * SourceCodePro-Semibold.woff
+    /// * SourceSerifPro-Bold.woff
+    /// * SourceSerifPro-Regular.woff
+    pub fn add_essential_files(&self) -> Result<(), DocBuilderError> {
+        use std::fs::{copy, create_dir_all};
+
+        // acme-client-0.0.0 is an empty library crate and it will always build
+        let pkg = try!(get_package("acme-client", Some("=0.0.0")));
+        let res = self.build_package_in_chroot(&pkg);
+        let rustc_version = parse_rustc_version(&res.rustc_version);
+
+        if !res.build_success {
+            return Err(DocBuilderError::GenericError(format!("Failed to build empty crate for: {}",
+                                                             res.rustc_version)));
+        }
+
+        info!("Copying essential files for: {}", res.rustc_version);
+
+        let files = (
+            // files require rustc version subfix
+            ["rustdoc.css",
+             "main.css",
+             "main.js",
+             "jquery.js",
+             "playpen.js"],
+            // files doesn't require rustc version subfix
+            ["normalize.css",
+             "FiraSans-Medium.woff",
+             "normalize.css",
+             "FiraSans-Medium.woff",
+             "FiraSans-Regular.woff",
+             "Heuristica-Italic.woff",
+             "SourceCodePro-Regular.woff",
+             "SourceCodePro-Semibold.woff",
+             "SourceSerifPro-Bold.woff",
+             "SourceSerifPro-Regular.woff",
+            ],
+        );
+
+        let source = PathBuf::from(&self.options.chroot_path)
+            .join("home")
+            .join(&self.options.chroot_user)
+            .join(canonical_name(&pkg))
+            .join("doc");
+
+        // use copy_documentation destination directory so self.clean can remove it when
+        // we are done
+        let destination = PathBuf::from(&self.options.destination)
+            .join(format!("{}/{}",
+                          pkg.manifest().name(),
+                          pkg.manifest().version()));
+        try!(create_dir_all(&destination));
+
+        for file in files.0.iter() {
+            let source_path = source.join(file);
+            let destination_path = {
+                let spl: Vec<&str> = file.split('.').collect();
+                destination.join(format!("{}-{}.{}", spl[0], rustc_version, spl[1]))
+            };
+            try!(copy(source_path, destination_path));
+        }
+
+        for file in files.1.iter() {
+            let source_path = source.join(file);
+            let destination_path = destination.join(file);
+            try!(copy(source_path, destination_path));
+        }
+
+        let conn = try!(connect_db());
+        try!(add_path_into_database(&conn, "", destination));
+
+        try!(self.clean(&pkg));
+
+        Ok(())
+    }
 }
 
 
@@ -416,4 +510,14 @@ mod test {
         assert_eq!(parse_rustc_version("cratesfyi 0.2.0 (ba9ae23 2016-05-26)"),
                    "20160526-0.2.0-ba9ae23");
     }
+
+    #[test]
+    #[ignore]
+    fn test_add_essential_files() {
+        let _ = env_logger::init();
+        let options = DocBuilderOptions::from_prefix(PathBuf::from("../cratesfyi-prefix"));
+        let docbuilder = DocBuilder::new(options);
+
+        docbuilder.add_essential_files().unwrap();
+    }
 }